The latest articles on DEV Community by Anurag Gupta (@anurag5086). https://dev.to/anurag5086 https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F699526%2F3932175c-4a0f-4086-a217-804c0d3d4c22.jpeg https://dev.to/anurag5086 en Anurag Gupta Wed, 08 Sep 2021 12:57:33 +0000 https://dev.to/anurag5086/api-documentation-made-easy-4hjp https://dev.to/anurag5086/api-documentation-made-easy-4hjp <p>As this is my first technical blog, so I'm pretty excited for this one.</p> <h2> How can you document your API without any hassle? </h2> <p>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.</p> <p>I recently came across this NPM package and was mind blown.</p> <p>API Link - <a href="https://apidocjs.com/" rel="noopener noreferrer">apiDOC</a> </p> <h3> Why to use this for documentation? </h3> <p>The documentation of this package is really clear and concise, but ill just put out few points which I really liked about apiDOC.</p> <ul> <li><p>Very easy to get started with.</p></li> <li><p>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 <a href="https://apidocjs.com/#params" rel="noopener noreferrer">params</a> being used, do check them out in the documentation. This makes API documentation an easy and simple task.<br> </p></li> </ul> <div class="highlight js-code-highlight"> <pre class="highlight plaintext"><code>/** * @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" * } */ </code></pre> </div> <ul> <li>It automatically generates the API documentation with an amazing UI. You can refer the demo given below. Isn't it amazing?</li> </ul> <p><a href="https://apidocjs.com/example/" rel="noopener noreferrer">Link to demo</a> </p> <p><a href="https://media.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fcdn.hashnode.com%2Fres%2Fhashnode%2Fimage%2Fupload%2Fv1631020324603%2FPMiEJQydd.png" class="article-body-image-wrapper"><img src="https://media.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fcdn.hashnode.com%2Fres%2Fhashnode%2Fimage%2Fupload%2Fv1631020324603%2FPMiEJQydd.png" alt="image.png"></a></p> <ul> <li>It supports various languages like Java, JavaScript, PHP, Perl, Python, Ruby, Lua, and many more.</li> </ul> <p>If you gained some value from this blog, please share it with your fellow developers and help them grow as well. Peace!</p> <p>Let's connect, <br> Follow me on Twitter - <a href="https://twitter.com/anurag_gupta23" rel="noopener noreferrer">Twitter</a> </p> react node python javascript