REST API Best practices: args in query string vs in request body

by

What are the best practices and considerations of choosing between 1
and 2 above?

Usually the content body is used for the data that is to be uploaded/downloaded to/from the server and the query parameters are used to specify the exact data requested. For example when you upload a file you specify the name, mime type, etc. in the body but when you fetch list of files you can use the query parameters to filter the list by some property of the files. In general, the query parameters are property of the query not the data.

Of course this is not a strict rule – you can implement it in whatever way you find more appropriate/working for you.

You might also want to check the wikipedia article about query string, especially the first two paragraphs.

More Related Contents:

  1. What is “406-Not Acceptable Response” in HTTP?
  2. Use of PUT vs PATCH methods in REST API real life scenarios
  3. Create REST API without using any backend
  4. How do I POST JSON data with cURL?
  5. Posting a File and Associated Data to a RESTful WebService preferably as JSON
  6. AngularJS: factory $http.get JSON file
  7. How to make HTTP Post request with JSON body in Swift
  8. REST – HTTP Post Multipart with JSON
  9. Disable Hypertext Application Language (HAL) in JSON?
  10. Standardized way to serialize JSON to query string?
  11. How do I send a JSON string in a POST request in Go
  12. Flutter FormatException: Unexpected character (at character 1)
  13. What is the difference between resource and resource representation in REST?
  14. Curl GET request with json parameter
  15. REST with Spring and Jackson full data binding
  16. Why does RestTemplate not bind response representation to PagedResources?
  17. JSON parse error: Can not construct instance of java.time.LocalDate: no String-argument constructor/factory method to deserialize from String value
  18. Post a json body with swagger
  19. Spring REST service: retrieving JSON from Request
  20. OpenAPI path/query parameters nested structure serialization
  21. Decode JSON as it is still streaming in via net/http
  22. Unable to find a MessageBodyReader of content-type application/json and type class java.lang.String
  23. JSON, REST, SOAP, WSDL, and SOA: How do they all link together
  24. Modify default JSON error response from Spring Boot Rest Controller
  25. JsonMappingException: could not initialize proxy – no Session
  26. Build a JSON string with Bash variables
  27. How to Deserialize a list of objects from json in flutter
  28. Error 415 Unsupported Media Type: POST not reaching REST if JSON, but it does if XML
  29. Convert a JSON array to a bash array of strings
  30. How to parse json and read in vb.net

Leave a Comment