Content Negotiation - Offered and Accepted

[jeevatkm]

Content Negotiation

Content negotiation is used to validate what is being offered and accepted by server in-terms of request and response. (also known as Content-Type restriction)

Offered - Accept HTTP header RFC2616

The resource identified by the request is only capable of generating
response entities which have content characteristics not acceptable
according to the accept headers sent in the request.

For example: Client sends Accept header as application/xml. However server only supports serving JSON i.e. application/json. Then server responds with 406 Not Acceptable.

Accepted - Content-Type HTTP header RFC2616

The server is refusing to service the request because the entity of
the request is in a format not supported by the requested resource
for the requested method.

For example: Client sends Content-Type header as application/xml. However server only supports JSON payload as request body. Then server responds with 415 Unsupported Media Type.

Configuration

# aah provides `Content Negotiation` feature for the incoming HTTP request.
  # Read more about implementation and RFC details here Github #75.
  # Perfect for REST API, also can be used for web application too if needed.
  content_negotiation {
    # To enable Content Negotiation for the application.
    # Default value is `false`.
    #enable = true

    # For example: Client sends Accept header as `application/xml`.
    # However server only supports serving JSON i.e. `application/json`.
    # Then server responds with 406 Not Acceptable.
    # Default value is empty list and disabled.
    #offered = ["application/json", "text/json"]

    # For example: Client sends Content-Type header as `application/xml`.
    # However server only supports JSON payload as request body.
    # Then server responds with 415 Unsupported Media Type.
    # Default value is empty list and disabled.
    #accepted = ["application/json", "text/json"]
  }

[jeevatkm]

Also known as Content-Type restriction.

[jeevatkm]

Merged :)