Files
api-guidelines/execution/query-requests-with-large-inputs.md
apidesigner 869ab8c06a Updates execution/query-requests-with-large-inputs.md
Auto commit by GitBook Editor
2017-02-24 07:56:51 +00:00

20 lines
896 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Query Requests with Large Inputs
While HTTP doesn't impose any limit on the length of an URI some implementation of server or client might have difficulties handling long URIs (usually URIs with many or large query parameters).
Every endpoint with such an URI **MUST** use the HTTP **POST** Request Method and send the query string in HTTP Request Message body using the `application/x-www-form-urlencoded` media type.
_NOTE: Since this operation is safe and idempotent, using the POST method is a misuse of HTTPs uniform interface. A consequence of this implementation is a loss of cache-ability.
#### Example
```
POST /orders HTTP/1.1
Content-Type: application/x-www-form-urlencoded
search=attributes&color=white&size=56&...
```
> _NOTE: Since this operation is safe and idempotent, using the POST method violates the HTTP Protocol semantics and results in loss of cache-ability._