Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates protocol/content-negotiation.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-02-01 16:35:51 +00:00
parent 8eb4d9784c
commit d2cbc984a5
2 changed files with 19 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
protocol/content-negotiation.md
View File

@@ -1,10 +1,22 @@
# Content Negotiation
Every API MUST implement and every API Consumer MUST use [HTTP content negotiation](https://tools.ietf.org/html/rfc7231#section-3.4) where a representation of a resource is requested.
#### Example
A client is programmed to use the `application/vnd.example.resource+json; version=2` media type. The client requests a representation of the `/greeting` resource in desired the media type (including its version) from the server:
```
GET /greeting HTTP/1.1
Accept: application/vnd.example.resource+json; version=2
...
```
The server is able to provide only a newer version of the requested media type `version=2.1.3`. But since the newer version is backward compatible with the requested `version=2` (related: Changes & Versioning) it is able to satisfy the request and responds:
```
HTTP/1.1 200 OK
Content-Type: application/vnd.example.resource+json; version=2.1.3
...
```
https://tools.ietf.org/html/rfc7231#section-3.4
https://tools.adidas-group.com/confluence/display/EA/API+Versioning+and+Compatibility
https://developer.mozilla.org/en-US/docs/Web/HTTP/Content_negotiation
https://en.wikipedia.org/wiki/Content_negotiation