Cat Paw Software

この文書は読取専用です。文書のソースを閲覧することは可能ですが、変更はできません。もし変更したい場合は管理者に連絡してください。
<markdown>
# rest api status code

REST APIのレスポンスコード。異論は認める

| status code | description |
|-----|-----|
| 200 | (get)取得成功リクエスト、(put/patch)更新後に値を返す場合 |   
| 201 | (post)リソースが生成された場合。本来は作成されたリソースをボディに持ち、リソースURLをlocationヘッダで指定する必要がある、正直200でも良い |
| 202 | (post/put/patch)message queueで処理するなど非同期処理を行うとき、その受付が成功した場合 |
| 204 | (put/patch)リソース更新成功、(delete)リソース削除。レスポンスボディは何も設定しない。何か値を返す場合は200を使う |
| 400 | (all)入力書式エラー、数字が求められているのに文字列を送った、必須パラメータがない等（バリデーションエラー） |
| 401 | (all)認証（ログイン）が必要なAPIに認証せずにアクセスした場合 |
| 403 | (all)認証しているが、認証されたユーザがAPIを実行する権限がない（認可エラー） |
| 404 | (get/put/patch)指定したリソースidがなかった。※ 一覧取得や検索APIのgetで何も見つからなかった場合は404ではなく200で空リストを返す | 
| 409 | （put/patch）楽観ロックによる更新エラーが発生した場合、（post）作成しようとしたリソースが既に作成されていた場合 |
| 422 | (all)リクエストの書式は正しいが処理できない、バリデーションエラーなど。WEBDav拡張として定義されたが、RFC9110にHTTPの一部となった |
| 429 | (all)リクエストが多すぎる。APIの呼び出し上限に達した場合 |

## ツール

### prism 

OpenAPI Docからモックサーバを立ち上げる

- https://stoplight.io/open-source/prism


### redock

OpenAPIのドキュメントサーバを立ち上げる

- https://github.com/Redocly/redoc



</markdown>