Git Product home page Git Product logo

swagger-docs's Introduction

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

swagger-docs's People

Contributors

amishfaldu avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.