Google

Posts Tagged as iodocs


  1. Documenting the JSON Schema of your Rest APIs

    24 Apr 2012

    Recently at work I have been looking at how to document our Restful APIs. After a chat with a couple of developers we had defined the following requirements we wanted from our restful API documentation:

    • We needed to be able to document the URIs, HTTP methods, querystring parameters.
    • We wanted to be able to specify a bit of descriptive text associated with each API call.
    • A tool embedded in the docs that allowed the reader to call the live deployed API would be a plus.
    • Being able to define the schema of JSON objects returned by the APIs was a must have.

    tags: rest  api  iodocs  mashery  nodejs 

    There are comments.