Global design

General considerations on API design

General Principles
We choose to adopt three general principles. Here’s a shortcut to remember: RESTful, Hypermedia, Fine-grained
API and domain modelling
External-facing APIs
Mobile-friendly APIs
Public-friendly APIs
Resource Oriented Design
This Design Guide explains how to apply REST principles to API designs independent of programming language, operating system, or network protocol. It is NOT a guide solely to creating REST APIs.
What is a REST API?
Design flow
The Design Guide suggests taking the following steps when designing resource- oriented APIs
Design Patterns