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

openapi-definition

v0.1.2

Published

Tool to help build/define OpenApi Specification

Downloads

46

Readme

openapi-definition

NPM version

Tool to help build/define OpenAPI Specification

Installation

$ npm install openapi-definition

Usage

This is how to build your OpenAPI Specification by using openapi-definition

OpenAPI Specification Sample

let yourOpenApi = {
    "openapi": "3.0.0",
    "info": {
      "title": "Sample API",
      "description": "Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.",
      "version": "0.1.9"
    },
    "servers": [
      {
        "url": "http://api.example.com/v1",
        "description": "Optional server description, e.g. Main (production) server"
      }
    ],
    "paths": {}
  };

Add User Schema to OpenAPI Specification

const od = require('openapi-definition');
const { add, OpenApi, set } = od;
let yourOpenApi = {...};

//  Add User Schema
let user = {
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "name": {
      "type": "string"
    }
  }
};
od.add.components_schema(yourOpenApi, 'User', user)
//  add.components_schema(yourOpenApi, 'User', user)

console.log(yourOpenApi)

Output

{
  "openapi": "3.0.0",
  "info": {
    "title": "Sample API",
    "description": "Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.",
    "version": "0.1.9"
  },
  "servers": [
    {
      "url": "http://api.example.com/v1",
      "description": "Optional server description, e.g. Main (production) server"
    }
  ],
  "components": {
    "schemas": {
      "User": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

Add path /users to OpenAPI Specification

const od = require('openapi-definition');
const { OpenApi } = od;
let yourOpenApi = {...};

//  Users Path
const users_path = {
  "get": {
    "summary": "Returns a list of users.",
    "description": "Optional extended description in CommonMark or HTML.",
    "responses": {
      "200": {
        "description": "A JSON array of user names",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

//  Add users path

od.add.path(yourOpenApi, '/users', users_path);
//  or
od.set.custom(yourOpenApi, `${OpenApi.PATHS}/users`, users_path);

console.log(yourOpenApi)

Output

{
  "openapi": "3.0.0",
  "info": {
    "title": "Sample API",
    "description": "Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.",
    "version": "0.1.9"
  },
  "servers": [
    {
      "url": "http://api.example.com/v1",
      "description": "Optional server description, e.g. Main (production) server"
    }
  ],
  "components": {},
  "paths": {
    "/users": {
      "get": {
        "summary": "Returns a list of users.",
        "description": "Optional extended description in CommonMark or HTML.",
        "responses": {
          "200": {
            "description": "A JSON array of user names",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

##Docs

OpenApi - OpenAPI document fields

All OpenAPI fields. Holds all object paths to the OpenAPI root document.

const od = require('openapi-definition');
const {OpenApi} = od;
console.log(OpenApi)

Output

{
  OPENAPI: 'openapi',
  info: {
    DESCRIPTION: 'info.description',
    contact: {
      ROOT: 'info.contact',
      NAME: 'info.contact.name',
      URL: 'info.contact.url',
      EMAIL: 'info.contact.email',
    },
    license: {
      ROOT: 'info.license',
      NAME: 'info.license.name',
      URL: 'info.license.url',
    },
    ROOT: 'info',
    TERMS_OF_SERVICE: 'info.termsOfService',
    TITLE: 'info.title',
    VERSION: 'info.version',
  },
  SERVERS: 'servers',
  PATHS: 'paths',
  components: {
    ROOT: 'components',
    SCHEMAS: 'components.schemas',
    PARAMETERS: 'components.parameters',
    SECURITY_SCHEMES: 'components.securitySchemes',
    REQUEST_BODIES: 'components.requestBodies',
    RESPONSES: 'components.responses',
    HEADERS: 'components.headers',
    EXAMPLES: 'components.examples',
    LINKS: 'components.links',
    CALLBACKS: 'components.callbacks',
  },
  SECURITY: 'security',
  TAGS: 'tags',
  externalDocs: {
    ROOT: 'externalDocs',
    DESCRIPTION: 'externalDocs.description',
    URL: 'externalDocs.url',
  },
}

All functions

const od = require('openapi-definition');
const { OpenApi } = od;

let openApiDef = {};      //  Your OpenAPI definition

let schemas = {
  schema_1: 'Some data',
  schema_2: 'Some more data',
  schema_3: {description: 'A description', type: 'object'},
};

let dummyJSON = {
  //  Some data
  //  ...
};

let server = { 
  url: 'https://staging.gigantic-server.com/v1', 
  description: 'Staging server'
};

//  Add callback to OpenAPI definition.
od.add.components_callback(dummyJSON, key, openApiDef);

//  Add example to OpenAPI definition.
od.add.components_example(dummyJSON, key, openApiDef);

//  Add header to OpenAPI definition.
od.add.components_header(dummyJSON, key, openApiDef);

//  Add link to OpenAPI definition.
od.add.components_link(dummyJSON, key, openApiDef);

//  Add parameter to OpenAPI definition.
od.add.components_parameter(dummyJSON, 'limitParam', openApiDef);

//  Add requestBody to OpenAPI definition.
od.add.components_requestBody(dummyJSON, key, openApiDef);

//  Add response to OpenAPI definition.
od.add.components_response(dummyJSON, 'NotFound', openApiDef);

//  Add schema to OpenAPI definition.
openApi.add.components_schema(schemas.schema_1, 'yourSchema', openApiDef);

//  Add securityScheme to OpenAPI definition.
od.add.components_securityScheme(dummyJSON, 'api_key', openApiDef);

//  Add path to OpenAPI definition.
od.add.path(dummyJSON, '/yourPath', openApiDef);

//  Add server to OpenAPI definition.
od.add.server(server, openApiDef);

//  Add security to OpenAPI definition.
od.add.security(dummyJSON, openApiDef);

//  Add tags to OpenAPI definition.
od.add.tag(dummyJSON, openApiDef);

//  Sets/overrides path 'externalDocs' in OpenAPI definition.
od.set.externalDocs(dummyJSON, openApiDef);

//  Sets/overrides path 'info' in OpenAPI definition.
od.set.info(dummyJSON, openApiDef);

//  Sets/overrides path 'info_contact' in OpenAPI definition.
od.set.info_contact(dummyJSON, openApiDef);

//  Sets/overrides path 'info_license' in OpenAPI definition.
od.set.info_license(dummyJSON, openApiDef);

//  Sets/overrides path 'openapi' in OpenAPI definition.
od.set.openapi(dummyJSON, openApiDef);

//  Sets/overrides path 'yourOwnPath' in OpenAPI definition.
od.set.other(dummyJSON, 'yourOwnPath' || 'components.examples', openApiDef);

License

MIT