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/know-your-http.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-02-01 15:08:18 +00:00
parent 5f1c5ff520
commit 2d4c7879a1
1 changed files with 15 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
protocol/know-your-http.md
View File

@@ -1,8 +1,5 @@
# Know your HTTP
HTTP headers, media-types, methods, relations and status codes, all summarized and linking to their specification. https://github.com/for-GET/know-your-http-well
Download posters at https://github.com/bigcompany/know-your-http
Every API using HTTP/S MUST conform to the HTTP/S protocol semantics as defined in the following RFCs:
> [RFC 7230, HTTP/1.1: Message Syntax and Routing](https://tools.ietf.org/html/rfc7230)
> [RFC 7231, HTTP/1.1: Semantics and Content](https://tools.ietf.org/html/rfc7231)
@@ -11,6 +8,20 @@ Download posters at https://github.com/bigcompany/know-your-http
> [RFC 7234, HTTP/1.1: Caching](https://tools.ietf.org/html/rfc7234)
> [RFC 7235, HTTP/1.1: Authentication](https://tools.ietf.org/html/rfc7234)
## HTTP Protocol Quick Start
The understanding of HTTP starts with the understanding of [HTTP message](https://developer.mozilla.org/en-US/docs/Web/HTTP/Messages) and its routing.
Once you are familiar with the structure of a HTTP/1.1 message learn about the _HTTP request methods, HTTP response status codes and HTTP headers_. Each _HTTP request method, status code and header_ has its semantics defined and every API MUST adhere to it.
Follow the [Robustness Principle](core-principles/robustness.md). Use only the _HTTP request methods, response codes and HTTP headers_ you understand but be liberal in accepting others, but make sure to understand those mentioned in the guidelines.
For quick information on _HTTP headers, media-types, methods, relations and status codes_, all summarized and linking to their specification visit [KNOW YOUR HTTP * WELL](https://github.com/for-GET/know-your-http-well).
Alternatively, you can download HTTP cheat sheets at [HTTP posters](https://github.com/bigcompany/know-your-http).