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

1. Quick swagger api docs. ✅

2. Auto-generate api docs for the routes you write and attach to web frameworks. ✅

3. Changes made to api also reflects in swagger api docs without modifying frustrating doc code. ✅

4. Auto-detect parameters, authentication, request body, response body from the api routes defined. ✅

5. Minimal dependency library for generating swagger api docs. ✅

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

1. Decorators & metadata reflection in Typescript