get-openapi-paths

Produces a best-effort list of paths in OpenAPI format from various web frameworks

Usage no npm install needed!

<script type="module">
  import getOpenapiPaths from 'https://cdn.skypack.dev/get-openapi-paths';
</script>

README

get-openapi-paths

This library tries to return paths from various frameworks for inclusion in an auto-generated OpenAPI specification

Supports:

  • koa-router
  • koa/router
  • express
  • connect (routes only, no methods)
  • fastify

Does not support:

  • koa-route

Sample output

const getPaths = require('get-openapi-paths');
const express = require('express');

const app = express();

app.get('/foo', ...);

const paths = getPaths(app);

/*
paths is:
{
    '/foo': {
        get: {}
    }
}
*/

Prior Art