API Implementation Guidelines

Introduction

There are an increasing number of APIs being developed at Hackney and these guidelines are designed to provide a clear set of implementation guides to bring consistency between the different endpoints.

They are 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.