API Standards

Introduction

These are a set of API guidelines based on the excellent set created by Zalando.

Contents

• Design Principles
• General Guidelines
• Security
• Compatibility
• Deprecation
• Naming
• HTTP
• Resources
• Pagination
• Data Formats
• Operation
• References

Conventions

The requirement level keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" used in this document (case insensitive) are to be interpreted as described in RFC2119. The titles are marked with the corresponding labels.