‘Best’ practice for restful POST response

by

Returning the new object fits with the REST principle of “Uniform Interface – Manipulation of resources through representations.” The complete object is the representation of the new state of the object that was created.

There is a really excellent reference for API design, here: Best Practices for Designing a Pragmatic RESTful API

It includes an answer to your question here: Updates & creation should return a resource representation

It says:

To prevent an API consumer from having to hit the API again for an
updated representation, have the API return the updated (or created)
representation as part of the response.

Seems nicely pragmatic to me and it fits in with that REST principle I mentioned above.

More Related Contents:

  1. JAVA Rest API and angular JS
  2. What exactly is RESTful programming?
  3. Best practices for API versioning? [closed]
  4. If REST applications are supposed to be stateless, how do you manage sessions?
  5. Free Rest API to retrieve current datetime as string (timezone irrelevant) [closed]
  6. Design RESTful query API with a long list of query parameters [closed]
  7. Transactions in REST?
  8. How to QUEUE a new build using VSTS REST API
  9. What is RESTful programming?
  10. Security of REST authentication schemes
  11. How to make remote REST call inside Node.js? any CURL?
  12. How to understand “RESTful API is stateless”?
  13. Best practice for partial updates in a RESTful service
  14. RESTful way to create multiple items in one request
  15. Querystring in REST Resource url
  16. How to refresh / invalidate $resource cache in AngularJS
  17. Spring @ExceptionHandler does not work with @ResponseBody
  18. Why the slow WADL uptake? [closed]
  19. REST vs JSON-RPC? [closed]
  20. Azure Websites Kudu REST API – Authentication
  21. REST api: requesting multiple resources in a single get [duplicate]
  22. How to format Swagger 2.0 text descriptions?
  23. Update an entire resource collection in a REST way
  24. What are the best/common RESTful url verbs and actions?
  25. How should the header X-DocuSign-Authentication be used for REST and SOAP?
  26. How to create new build pipeline using Azure DevOps REST API?
  27. How one could use server side sorting and paging with Azure Mobile Services
  28. How to do a PUT request with cURL?
  29. What REST PUT/POST/DELETE calls should return by a convention?
  30. Get/post to RESTful web service

Leave a Comment