LoginSignup
1
0

(架空の)更新系APIの仕様

Last updated at Posted at 2024-03-25

はじめに

更新系APIのタイムアウトで発生する課題を整理するために架空の更新系APIの仕様をまとめる。
実際には存在しないAPIだが、更新系APIを一般化したつもり。

プロトコル

  • HTTP or HTTPS
  • POST,SOAP,JSONをイメージ

通信要件

  • パブリックインターネット,LAN,Private IP-NWをイメージ
  • サーバ間通信(つまりクライアントはブラウザではない)

リクエストの種類

No 状態 説明 備考
1 更新リクエスト Authorization request
2 取消リクエスト Cancel request
3 参照リクエスト サーバ側の状態は遷移はしない Query request
4 ファイルリクエスト 照合ファイルを返却する Reconciliation file

サーバの状態遷移図

クライアントの状態遷移図

状態の説明

No 状態 説明 備考
1 初期状態(null) 更新リクエストが発生する前の状態
2 処理済み 正常に更新処理が行われた状態
3 不明 更新リクエストのレスポンスが未受信の際のクライアントの状態 クライアントのみ発生する状態
4 取消 更新リクエスト自体がなかったものとする ここでは、取消を取消して処理済み状態に戻せないものとする

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0