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
Files
7a43b62f71555779df7969be94b9deb853e79793
api-guidelines/rest/protocol/know-your-http.md
apidesigner 958d90ea5d Creates rest/core-principles/quality.md 
Auto commit by GitBook Editor
2018-06-23 12:56:08 +00:00

1.6 KiB
Raw Blame History

Know your HTTP

Every API using HTTP MUST conform to the HTTP protocol semantics as defined in the following RFCs:

  1. RFC 7230, HTTP/1.1: Message Syntax and Routing
  2. RFC 7231, HTTP/1.1: Semantics and Content
  3. RFC 7232, HTTP/1.1: Conditional Requests
  4. RFC 7233, HTTP/1.1: Range Requests
  5. RFC 7234, HTTP/1.1: Caching
  6. RFC 7235, HTTP/1.1: Authentication

HTTP Protocol Quick Start

The understanding of HTTP starts with the understanding of HTTP message and its routing.

Once you are familiar with the structure of an 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. Use only the HTTP request methods, response codes, and HTTP headers you understand but be liberal in accepting others, but make sure to follow those mentioned in the guidelines.

For quick information on HTTP headers, media-types, methods, relations and status codes, all summarized and linked to their specification visit KNOW YOUR HTTP * WELL.

Alternatively, you can download HTTP cheat sheets at HTTP posters.