31

Pro Tip: if you're building a developer REST API, don't forget to add a sample response to each endpoint. I don't want to have to test each one when I'm building my integration, I'd rather build my model in one go with the documentation displayed on a second monitor.

Comments
  • 4
    You're so right!!! I hate when the docs explain it all BUT the response
  • 3
    If I could ++ this a thousand times, I would. The amount of time I've spent in Postman doing this is insane.
  • 4
    Swagger ftw
  • 5
    @jsmrcaga If the docs are good they should include the response, in all formats available.
  • 1
    The ones I've worked with have a dedicated dev environment/URL which resets all data you send every 24 hours and doesn't effect anything. Not normally like that?
  • 1
    Even thought I have a good spec - it quickly becomes outdated as the service evolves. Developers often forget to update the specs.
    In my practice I have to perform every rest call (e.g. with Postman) to make sure "the params, headers and response are matching the spec"!
    Moreover I often have to dive into backend source code to check for edge cases.
    That said - what you are doing is not that bad :)
Add Comment