Skip to content

REST API Guidelines

HTTP APIs are required to be RESTful. See API Design.

HTTP Basics

Every API MUST be compatible to HTTP/1.1 and MUST follow its semantics.

An understanding of HTTP, its status codes, headers, request methods etc. is essential. They are 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