arrow-docgen/source/response.md

Arrow API Documentation Generator

# Response

	**Console Tip**

	When testing in console using CURL, you can supply the `-is` flag to print HTTP headers.  For example:

	`$ curl -is $ENDPOINT_URL`

This API provides some special built-in capabilities as part of each HTTP response.

	### Example Response Headers
	`Content-Encoding: gzip
	Content-Type: application/json; charset=utf-8
	Access-Control-Allow-Origin: *
	Access-Control-Allow-Headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
	Access-Control-Allow-Methods: GET, POST
	Access-Control-Expose-Headers: Api-Version, Request-Id, Response-Time
	Connection: Keep-Alive
	Content-Md5: A2zOyTxAm85dOp4LI1yGFg==
	Date: Sat, 13 Sep 2014 05:28:39 GMT
	Server: Appcelerator Appcelerator Arrow/1.0.0
	Request-Id: d144d830-3b06-11e4-9e05-8ddbf56760f7
	Response-Time: 3
	Transfer-Encoding: chunked`

### Compression

If your client sends an appropriate `Accept-Encoding` HTTP header, the response will automatically be compressed.

### Cross Origin Resource Sharing

This API provides automatic [CORS](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing) headers in the HTTP response.

### Request Id

This API will automatically generate a [universally unique identifier](http://en.wikipedia.org/wiki/Universally_unique_identifier) for each request.  The HTTP header name is `Request-Id`.

### Content Verification

This API will automatically generate a [Content-MD5](http://tools.ietf.org/html/rfc1864) HTTP header to verify the message integrity.  The HTTP header name is `Content-Md5`. You can use the value of this header to validate that the content has not changed in transit since it was generated by the API.

### Response Time

This API will automatically generate a HTTP header to indicate the duration of time in milliseconds it took for the API to generate the response.  The name of the HTTP header is `Response-Time`.