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

express-openapi-middleware

v1.2.1

Published

Yet another tool to integrate ExpressJS and OpenAPI

Downloads

10

Readme

Inline docs Build Status dependencies Status devDependencies Status

A fairly small library that provides middleware to define and validate routes similarly to express-jsonschema and utility to create OpenAPI 3.0.x compatible "paths" object from those definitions.

Advantages over similar integration tools:

  • Modular - documentaion can be chained and mounted just like regular middleware.
  • Flexible - no need to modify a single single line of existing application logic.
  • No code duplication - validation rules and documentaion are the same thing, right next to actual implementation.
  • No Router or Application modifications needed - it's just a middleware.
  • Small and simple

Limitations:

  • No support for optional and repeated path variables (yet)
  • Documentation generation skips routes that have non-standard path regular expressions (i.e. not compatible to those generated by path-to-regexp).
  • Route middlewares are considered leaves (i.e. routers mounted to Route-s are not scanned).

Note: Documentation objects should generally be immutable.

Usage

import { Router } from 'express';
import { apiOperation, createPaths } from 'express-openapi-middleware';


const router = new Router;

router.get('/pet/:pet', apiOperation({
	tags: [ 'Pet' ],
	summary: 'List pets',
	parameters: [{
		in: 'path',
		name: 'pet',
		description: 'Pet ID',
		required: true,
		schema: {
			type: 'string',
			minLength: 1
		}
	}]
}), (req, res, next) => {
	db.get(req.params.pet)
		.then(pet => {
			res.send(pet);
		}, next)
});


const pathsObject = createPaths(router);

/**
pathsObject =>
  /pet/{pet}:
    get:
      tags:
        - Pet
      summary: 'List pets'
      parameters:
        - in: 'path'
          name: 'pet'
          description: 'Pet ID'
          required: true
          schema:
            type: 'string'
            minLength: 1
*/

How it works

Validation works very similarly to express-jsonschema. To generate the OpenAPI "paths" object, createPaths(router) recursively scans router for Route-s while creating chains of paths and apiOperation middlewares. The "operation" objects attached to these middlewares are then merged together and added to "paths" object.

License

MIT