@types/swagger-ui-express

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');
});