{"_id":"54fadd49f63cf9210041c66a","__v":1,"version":{"_id":"54fa0050f63cf9210041c3c1","__v":5,"project":"54fa004ff63cf9210041c3be","createdAt":"2015-03-06T19:30:24.258Z","releaseDate":"2015-03-06T19:30:24.258Z","categories":["54fa0050f63cf9210041c3c2","54fa42b3961fea210092068e","54facefd5c41173700ecf296","54fad9d5f63cf9210041c669","54fae9ed5c41173700ecf2ad"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"54fad9d5f63cf9210041c669","project":"54fa004ff63cf9210041c3be","__v":6,"pages":["54fada07961fea21009206fb","54fada3d5c41173700ecf29c","54fadd49f63cf9210041c66a","54fadd895c41173700ecf2a2","54faddd35c41173700ecf2a4","54fadea0f63cf9210041c66d"],"version":"54fa0050f63cf9210041c3c1","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-07T10:58:29.385Z","from_sync":false,"order":4,"slug":"contributing","title":"Contributing"},"githubsync":"","project":"54fa004ff63cf9210041c3be","user":"54fa0018e7a0ba2f00306211","updates":["54fb44d567c8370d00b5c27e"],"next":{"pages":[],"description":""},"createdAt":"2015-03-07T11:13:13.349Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"API documentation can be generated by running the following command:\n\n```\n$ npm run docs\n```\n\nAnd these docs can be served locally by running:\n```\n$ npm run docs-server\n```\n\n...and going to `http://localhost:9002` in the browser to see them.\n\nThe API documentation is generated from `docs/api-blueprint.md`.\n\nThese docs are also hosted on Apiary; read more [here](http://paz.readme.io/v1.0/docs/rest-apis)","excerpt":"How to generate and update API documentation on REST APIs","slug":"api-documentation","type":"basic","title":"API Documentation"}

API Documentation

How to generate and update API documentation on REST APIs

API documentation can be generated by running the following command: ``` $ npm run docs ``` And these docs can be served locally by running: ``` $ npm run docs-server ``` ...and going to `http://localhost:9002` in the browser to see them. The API documentation is generated from `docs/api-blueprint.md`. These docs are also hosted on Apiary; read more [here](http://paz.readme.io/v1.0/docs/rest-apis)