Query String VS. Request Body. Where to send the object?

inaka / rest_guidelines

REST API Design Guidelines

Apache License 2.0

11 stars 1 forks source link

Open agerace opened 7 years ago

agerace commented 7 years ago

Where to send parameters or objects? GET => On the query string PUT, PATCH, POST, DELETE => On the request body

elbrujohalcon commented 7 years ago

More explicitely…

QS is only valid on GET and every parameter that it includes represents a filter on the data that needs to be returned
The only purpose that a parameter in the path can have is to identify a resource (that's for all verbs)
Every other parameter (in POST, PATCH, PUT, etc.) should go in the request body
Parameters that doesn't match any of these rules (like those used for authentication or api versioning or maybe even pagination) should go in headers.