express_swagger_jsdoc_autodoc_api_documentation_quickstart.ts

1import express, { Request, Response } from 'express';
2import swaggerJsdoc from 'swagger-jsdoc';
3import swaggerUi from 'swagger-ui-express';
4
5const app = express();
6const port = 3000;
7
8// Swagger definition
9const options: swaggerJsdoc.Options = {
10  definition: {
11    openapi: '3.0.0',
12    info: {
13      title: 'Hello World API',
14      version: '1.0.0',
15      description: 'A simple Express API with Swagger documentation',
16    },
17    servers: [
18      {
19        url: 'http://localhost:3000',
20      },
21    ],
22  },
23  // Path to the API docs (files containing JSDoc comments)
24  apis: ['./src/*.ts'], 
25};
26
27const swaggerSpec = swaggerJsdoc(options);
28
29// CSS/UI Setup
30app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
31
32/**
33 * @openapi
34 * /:
35 *   get:
36 *     description: Welcome to swagger-jsdoc!
37 *     responses:
38 *       200:
39 *         description: Returns a mysterious string.
40 */
41app.get('/', (req: Request, res: Response) => {
42  res.send('Hello World!');
43});
44
45/**
46 * @openapi
47 * /users:
48 *   get:
49 *     description: Get all users
50 *     responses:
51 *       200:
52 *         description: Success
53 */
54app.get('/users', (req: Request, res: Response) => {
55  res.json([{ id: 1, name: 'John Doe' }]);
56});
57
58app.listen(port, () => {
59  console.log(`Server running at http://localhost:${port}`);
60  console.log(`Swagger docs available at http://localhost:${port}/api-docs`);
61});