npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@amishfaldu/swagger-docs

v1.1.0

Published

A node.js package to create swagger api docs hassle free

Downloads

261

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

  1. Quick swagger api docs. :white_check_mark:

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

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

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

  5. 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

  1. Decorators & metadata reflection in Typescript