Skip to content

Latest commit

 

History

History

swagger-ui

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

swagger-ui

Swagger UI Frontend middleware

This middleware is marked as legacy and should be used only for supporting old project

Installation

npm i @nanoexpress/middleware-swagger-ui
# or
yarn add @nanoexpress/middleware-swagger-ui

Example

See the examples directory

Usage

ESM Module

import swaggerUi from '@nanoexpress/middleware-swagger-ui';

app.define(swagger); // For nanoexpress this line doesn't need
app.use('/swagger-ui-dist', swaggerUi());

CJS Module

const swaggerUi = require('@nanoexpress/middleware-swagger-ui/cjs');

app.define(swagger); // For nanoexpress this line doesn't need
app.use('/swagger-ui-dist', swaggerUi());

Options

Options name Default Required Description
options.title nanoexpress - ReDoc No Title of documentation page
options.path /docs/ No Path of documentation page
options.url - No URL of Swagger file

License

MIT