• Table of Contents
  • 1. Introduction
  • 2. Design Principles
  • 3. General Guidelines
  • 4. Security
  • 5. Compatibility
  • 6. JSON Guidelines
  • 7. Naming
  • 8. Resources
  • 9. HTTP
  • 10. Performance
  • 11. Pagination
  • 12. Hypermedia
  • 13. Data Formats
  • 14. Common Data Objects
  • 15. Common Headers
  • 16. Proprietary Headers
  • 17. Deprecation
  • 18. API Operation
  • 19. Events
  • 20. References
  • 21. Tooling
  • Published with GitBook

Introduction

References

This section collects links to documents to which we refer, and base our guidelines on.

OpenAPI Specification

  • OpenAPI Specification

Publications, specifications and standards

  • RFC 3339: Date and Time on the Internet: Timestamps
  • RFC 5988: Web Linking
  • RFC 7159: The JavaScript Object Notation (JSON) Data Interchange Format
  • RFC 7230: Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing
  • RFC 7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content
  • RFC 7807: Problem Details for HTTP APIs
  • ISO 8601: Date and time format
  • ISO 3166-1 alpha-2: Two letter country codes
  • ISO 639-1: Two letter language codes
  • ISO 4217: Currency codes
  • BCP 47: Tags for Identifying Languages

Dissertations

  • Roy Thomas Fielding - Architectural Styles and the Design of Network-Based Software Architectures. This is the text which defines what REST is.

Books

  • REST in Practice: Hypermedia and Systems Architecture
  • Build APIs You Won't Hate
  • InfoQ eBook - Web APIs: From Start to Finish

Blogs

  • Lessons-learned blog: Thoughts on RESTful API Design