API Guidelines: Difference between revisions
Jump to navigation
Jump to search
(Created page with "* Clients must never construct URLs without a template. * Versioning should be done using Content Type Negotiation. * Resources should use HTTP...") |
No edit summary |
||
| Line 7: | Line 7: | ||
* [[Pagination]] should use absolute ids for offset calculation instead of relative to the first page. | * [[Pagination]] should use absolute ids for offset calculation instead of relative to the first page. | ||
* [[Media Types]] should have a description of the format to expect as well as the interactions you can make when you're viewing that resource. | * [[Media Types]] should have a description of the format to expect as well as the interactions you can make when you're viewing that resource. | ||
* The API should be explorable using a web browser. | |||
Revision as of 08:33, 30 November 2020
- Clients must never construct URLs without a template.
- Versioning should be done using Content Type Negotiation.
- Resources should use HTTP Caching.
- Relationships between resources should be modeled using links.
- Updates to resources should use Optimistic Concurrency using ETags.
- GET, DELETE and PUT must be idempotent.
- Pagination should use absolute ids for offset calculation instead of relative to the first page.
- Media Types should have a description of the format to expect as well as the interactions you can make when you're viewing that resource.
- The API should be explorable using a web browser.