/WebAPIDesign

Web API Design Standards

WebAPIDesign

Web API Design Standards

Advantages

Platform Independence

Service Evolution

Designed Around Resources

REST API Maturity Model

  • Level 0 - Define one URI, and all operations are POST to this URI
  • Level 1 - Create separate URIs for individual resources
  • Level 2 - Use HTTP Methods to define operatiosn on resources
  • Level 3 - Use hypermedia (HATEOAS)

Resources

Web References

  1. https://mathieu.fenniak.net/the-api-checklist/
  2. https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md
  3. https://www.openapis.org/
  4. https://12factor.net/
  5. https://stackoverflow.blog/2020/03/02/best-practices-for-rest-api-design/
  6. https://cloud.google.com/apigee/

Books

  1. https://www.oreilly.com/library/view/restful-web-apis/9781449359713/