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

@grandlinex/docs-to-openapi

v0.6.0

Published

OpenApiTag to OpenapiSpec

Downloads

5

Readme

Docs to OpenApi v.3

Documentation

GitHub NPM TS

Description

This Project converts comments in your code or in your dependencies to an OpenApi Spec. The following annotations are supported.

  • @openapi
  • @swagger

All comments with these annotations will be pasted as a singe element in the path definition array. For all other OpenApi configs the glconf.json is used.

Installation

  • npm i -g @grandlinex/docs-to-openapi

Config fields

  • rootDir
    • Relative path to your sourcecode.
  • filetypes
    • List of file extensions to monitor.
  • externalModules
    • If your dependencies use also these annotations you can merge these in your curren spec.
  • outPutDir (optional)
    • Relative path for the Spec. output.

Quick Start

  1. Create a glconf.json in the root dir of your project (see config 01 or 02).

  2. Edit your base Config file like in the official Swagger Doc

  3. Add a Comment to your soruce code in yml syntax like:

         /**
          * @openapi
          * /ping:
          *   get:
          *     summary: ping
          *     tags:
          *       - basic
          *     responses:
          *       200:
          *         description: OK
          *       401:
          *         description: not authorized
          */
  4. run npx @grandlinex/docs-to-openapi

If you install the package as a dependency or global then you can use the makeOpenApi command.

CLI Parameter

|Parameter|Description| |---|---| |--html|Creates a swagger.html file (Standalone SwaggerUI)| |--serve|Serves the OpenApi Spec on port 9000|

Config File Examples:

Config 01 glconf.json (minimal)

  {
    "rootDir": "./src",
    "filetypes": ["ts","js"],
    "externalModules": [],
    "baseConfig": {
      "info": {
        "title": "Hello World",
        "version": "1.0.0",
        "description": "A sample API"
      },
      "servers": [
        {
          "url": "http://localhost:9257"
        }
      ]
    }
  }

Config 02 glconf.json (Bearer JWT)

  {
    "rootDir": "./src",
    "filetypes": ["ts","js"],
    "externalModules": ["./node_modules/module_a","./node_modules/module_b"],
    "outPutDir": "./dist",
    "baseConfig": {
      "info": {
        "title": "Hello World",
        "version": "1.0.0",
        "description": "A sample API"
      },
      "servers": [
        {
          "url": "http://localhost:9257"
        }
      ],
      "security": [
        {
          "bearerAuth": []
        }
      ],
      "components": {
        "securitySchemes": {
          "bearerAuth": {
            "type": "http",
            "scheme": "bearer",
            "bearerFormat": "JWT"
          }
        }
      }
    }
  }