Package Exports

express-swagger-autogen
express-swagger-autogen/dist/autogen.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (express-swagger-autogen) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

express-swagger-autogen

A library that auto generates swagger docs to your endpoints from express.

Installation

npm install express-swagger-autogen

Usage

You must use the Router instance from express.
The autogen must be executed in the end your router stack.

For example:

import express from "express";
import expressSwaggerAutogen from "express-swagger-autogen";

const router = express.Router();

router.get("/healthcheck", controller);
// others routes ...

expressSwaggerAutogen(router);

const app = express();
app.use(router);
app.listen(3000, () => console.log("Server is running on http://localhost:3000"));

You may set some configurations as the second parameter of the autogen:

You own swagger object setup:

const config = {
    setup: {
        openapi: "3.0.0",
        info: {
            title: 'API Name' || process.env.npm_package_name,
            version: '1.0.0' || process.env.npm_package_version,
        }
    }
};

expressSwaggerAutogen(router, config);

You also may edit some endpoint documentation by passing an object with the endpoint path as key and the documentation as value:

router.get("/healthcheck", checkController);
router.post("/login", loginController);

expressSwaggerAutogen(router, {
    setup: {
        paths: {
            "/login": {
                post: {
                    summary: "User login with email and password",
                    parameters: [],
                    requestBody: { /* Your login request interface */ },
                    responses: { /* Your login response interface */ },
                    ... // other OpenAPI properties
                },
            },
        },
    },
});

The autogen will also validate your endpoints and methods from setup.paths and will dislay a warning if the endpoint set is not defined in your router instance. You also may enable the validatePaths flag to throw an error:

router.get("/products", controller);

try {
    expressSwaggerAutogen(router, {
        validatePaths: true,
        setup: {
            paths: {
                "/products": {
                    post: {
                        summary: "Will list your products",
                    },
                },
            },
        },
    });
} catch (error) {
    console.error("Error while setting up Swagger:", error);
    // Method "post" for path "/products" defined in setup.paths does not exist in the router endpoints. 
}

Options

Option	Type	Default Value	Description
`setup`	`object`	`{}`	Your own custom OpenAPI3 setup for Swagger UI. It will be merged with the default setup.
`validatePaths`	`boolean`	`false`	If true, it will validate the paths defined in `setup.paths`. If a path is defined in `setup.paths` but not in the router, it will throw an error. If false, it will only log a warning.
`endpoint`	`string`	`"/documentation"`	The endpoint where the swagger UI will be served. If you want to change it, you can pass a different value. For example, if you want to serve the swagger UI at `/api-docs`, you can pass `"/api-docs"`
`basePath`	`string`	`''`	Base path to prepend to all endpoints in swagger.

License

MIT