Read online at GitBook

The goal of this document is to facilitate the work and minimize the effort of all API users while protecting their investment and encouraging API adoption.

These guidelines lay down the foundation for collaboration, stability, and extensibility.

The API Guidelines are split into two main parts:

• General Guidelines
• API type-specific Guidelines
  • REST APIs Guidelines
  • Kafka Guidelines

The general guidelines section discusses the core principles relevant to any kind of API. The API type-specific section further defines the guidelines specific to a given architectural style or API technique (such as REST, Kafka or GraphQL APIs).

These Guidelines are available for online reading at GitBook its source can be found on GitHub.

The CAPITALIZED words throughout these guidelines have a special meaning:

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in 
this document are to be interpreted as described in RFC2119.

Refer to RFC2119 for details.

Please contact ? in the case of questions.

This project is intended to provide the guidelines for design & development of APIs.

Nobody is responsible for the usage of this software for different purposes that the ones described in the use cases.

MIT