Skip to content

11 Examples

Jump to bottom
dr3s edited this page Sep 3, 2019 · 3 revisions

RESTful Best Practices

These examples are for reference only and not part of the Best Practices

Tribe Service Before After
Doc Design UDS https://uds.documents.cimpress.io/swagger https://editor.swagger.io/?url=https://s3.amazonaws.com/rendering-infopage/uds-swagger.yaml
Products Surface https://developer.cimpress.io/apis/products/surface-specification-service https://editor.swagger.io/?url=https://s3-eu-west-1.amazonaws.com/ct-products-public/final_surface_swagger.yaml
Prepress Image and PDF Processing https://images.prepress.cimpress.io/swagger/ui/index https://editor.swagger.io/?url=https%3A%2F%2Fuploads.documents.cimpress.io%2Fv1%2Fuploads%2F56040d82-85f5-443d-abfe-d6839b387511~110%3Ftenant%3Dprepress-uploads%26noRedirect%3Dtrue (under construction)

RESTful Best Practices

  1. Terminology

  2. API Versioning

  3. JSON Conventions

  4. Resource Names and Locations

  5. Resource Relationships

  6. Resource Operations

  7. Asynchronous Requests

  8. Error Responses

  9. Response Status Codes

  10. Headers

  11. Examples

Clone this wiki locally