Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates protocol/use-appropriate-status-codes.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-02-14 16:24:00 +00:00
parent 54fa3a62ac
commit 88edcf5a7b
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
protocol/use-appropriate-status-codes.md
View File

@@ -1,13 +1,13 @@
# Use Appropriate Status Codes # Use Appropriate Status Codes
Every API MUST use the appropriate [HTTP Status Codes](https://github.com/for-GET/know-your-http-well/blob/master/status-codes.md) to communicate the result of a request operation. Every API **MUST** use the appropriate [HTTP Status Codes](https://github.com/for-GET/know-your-http-well/blob/master/status-codes.md) to communicate the result of a request operation.
Every API designer, implementer and consumer MUST understand the semantic of the HTTP Status Code she is using. Every API designer, implementer and consumer **MUST** understand the semantic of the HTTP Status Code she is using.
At a minimum everyone MUST be familiar with the semantics of ["Common" HTTP Status Codes](https://github.com/for-GET/know-your-http-well/blob/master/status-codes.md#common). At a minimum everyone **MUST** be familiar with the semantics of ["Common" HTTP Status Codes](https://github.com/for-GET/know-your-http-well/blob/master/status-codes.md#common).
--- ---
#### Example #### Example: Use Codes 4xx or 5xx to Communicate Errors
A request: A request:
``` ```
@@ -28,7 +28,7 @@ Content-Type: application/json
"message" "Order 1234 wasn't found" "message" "Order 1234 wasn't found"
} }
``` ```
is **illegal**. is **not acceptable**.
Instead the Instead the