Menu
I'm working on a restAPI using Express.js and I'm wondering if there is a way for me to generate API documents that allow a user to view API definitions or possibly even try out the API call?
611
Node. js is mature and it powers services for some huge companies like LinkedIn, Walmart, eBay, PayPal, Yahoo and others. Finally, I'd like to say that our experience also proves that Node. js is a great choice to construct REST API.
Express is a perfect choice for a server when it comes to creating and exposing APIs (e.g. REST API) to communicate as a client with your server application.
What you are looking for is a good JavaScript documentation generator. I found a decent one here http://apidocjs.com/example/. This will allow you to use just Express as OP asked.
Swagger isn't for generating docs, it's for making APIs. So you are going to need to learn a full system to get that feature.
I found a couple more here that I haven't fully looked into yet which seem promising:
Docco here JSDoc here and an article on Documentor for Node
88
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
