@types/swagger-ui-express

What is @types/swagger-ui-express?

@types/swagger-ui-express provides TypeScript type definitions for the swagger-ui-express package, which is used to serve auto-generated Swagger API documentation from an Express.js server.

What are @types/swagger-ui-express's main functionalities?

Serve Swagger UI

This feature allows you to serve the Swagger UI documentation for your API. The code sets up an Express.js server and uses swagger-ui-express to serve the Swagger documentation at the /api-docs endpoint.

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');

const app = express();

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000');
});

Customizing Swagger UI

This feature allows you to customize the appearance and behavior of the Swagger UI. The code demonstrates how to hide the top bar and set a custom site title for the Swagger documentation.

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');

const options = {
  customCss: '.swagger-ui .topbar { display: none }',
  customSiteTitle: 'My API Docs'
};

const app = express();

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));

app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000');
});

Other packages similar to @types/swagger-ui-express

swagger-jsdoc

swagger-jsdoc is a package that allows you to integrate JSDoc comments in your code to generate Swagger documentation. Unlike @types/swagger-ui-express, which serves the Swagger UI, swagger-jsdoc focuses on generating the Swagger specification from your code comments.

redoc

redoc is an alternative to swagger-ui-express for serving API documentation. It provides a more modern and customizable UI for your Swagger documentation. While @types/swagger-ui-express uses the Swagger UI, redoc offers a different user experience and additional customization options.

express-openapi-validator

express-openapi-validator is a package that not only serves Swagger documentation but also validates API requests and responses against the OpenAPI specification. This adds an extra layer of validation to your API, which is not a feature provided by @types/swagger-ui-express.

README

Installation

npm install --save @types/swagger-ui-express

Summary

This package contains type definitions for swagger-ui-express (https://github.com/scottie1984/swagger-ui-express).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/swagger-ui-express.

Additional Details

• Last updated: Fri, 21 Feb 2025 10:35:32 GMT
• Dependencies: @types/express, @types/serve-static

Credits

These definitions were written by Dmitry Rogozhny, and Florian Imdahl.