@amishfaldu/swagger-docs
v1.1.0
Published
A node.js package to create swagger api docs hassle free
Downloads
261
Maintainers
Readme
Swagger Docs
This library helps you to build swagger api docs hassle free by using decorators, reflect metadata api.
Documentation
For more information related to library usage and api references, head over to project's documentation.
To find answers for your question, ask questions, add suggestions or ideas to improve this project, engage in general discussion head over to project's discussion.
Current state / problems faced
To write swagger api docs for web apps developed using node.js without use of frameworks like nest.js, you will need to write annotated jsdoc and scroll though confusing swagger documentation to find right specification syntax for api routes.
Problems solved
What you acheive by using this library
Quick swagger api docs. :white_check_mark:
Auto-generate api docs for the routes you write and attach to web frameworks. :white_check_mark:
Changes made to api also reflects in swagger api docs without modifying frustrating doc code. :white_check_mark:
Auto-detect parameters, authentication, request body, response body from the api routes defined. :white_check_mark:
Minimal dependency library for generating swagger api docs. :white_check_mark:
Implementation
This library implements decorators for defining api routes, relect metadata apis to generate swagger api docs
References
For more information on decorators, metadata and reflection