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 execution/caching.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-06-19 08:40:57 +00:00
parent d91bfa4007
commit ca24ada594
1 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
execution/caching.md
View File

@@ -2,7 +2,27 @@
Every API implementation **SHOULD** return both the cache expiry information ([`Cache-Control` HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control)) and specific resource version information ([`ETag` HTTP Header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag)).
## Cache-Control
Every API implementation's response **SHOULD** include information about cache-ability and cache expiration of the response.
Every API implementation's response **SHOULD** include information about cache-ability and cache expiration of the response. For HTTP 1.1 this is achieved using the `Cache-Control` header.
### Common Cache-Control Scenarios
Two, most common scenarios for controling the cache-ability of a response includes (1) Setting expiration and revalidation and (2) disabling the caching of a response. Refer to the [Cache-Control Documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control) for additional controls.
#### 1. Cache Expiration & Revalidation
Common scenario to set cache expiration and revalidation is to use the `max-age` and `must-revalidate` directives:
```
HTTP/1.1 200 OK
Date: Mon, 19 Aug 2017 00:00:00 GM
Cache-Control: max-age=3600,must-revalidate
...
```
#### 2. Disabling Cache
## ETag
Every API implementation's response to a [cacheable request](https://github.com/for-GET/know-your-http-well/blob/master/methods.md#cacheable) **SHOULD** include the [`ETag` HTTP Header](https://tools.ietf.org/html/rfc7232#section-2.3) to identify the specific version of the returned resource.