26
API Documentation Made Easy
As this is my first technical blog, so I'm pretty excited for this one.
We all know that its very easy for us developers to code things out but when it comes to documentation, it feels really uninteresting and a boring job, I don't know is it just me.
I recently came across this NPM package and was mind blown.
API Link - apiDOC
The documentation of this package is really clear and concise, but ill just put out few points which I really liked about apiDOC.
Very easy to get started with.
Implementation is very simple, and it makes the code understandable. Look at the code snippet you'll get some idea how this can be implemented just by adding some lines as a comment. There are various params being used, do check them out in the documentation. This makes API documentation an easy and simple task.
/**
* @api {get} /user/:id Request User information
* @apiName GetUser
* @apiGroup User
*
* @apiParam {Number} id Users unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK
* {
* "firstname": "John",
* "lastname": "Doe"
* }
*
* @apiError UserNotFound The id of the User was not found.
*
* @apiErrorExample Error-Response:
* HTTP/1.1 404 Not Found
* {
* "error": "UserNotFound"
* }
*/
If you gained some value from this blog, please share it with your fellow developers and help them grow as well. Peace!
Let's connect,
Follow me on Twitter - Twitter
Follow me on Twitter - Twitter
26