利用typescript生成Swagger文档
时间: 2023-11-22 10:04:58 浏览: 49
要利用 TypeScript 生成 Swagger 文档,可以采用以下步骤:
1. 安装 `swagger-jsdoc` 和 `swagger-ui-express` 库:
```
npm install swagger-jsdoc swagger-ui-express --save
```
2. 在 TypeScript 代码中使用 `swagger-jsdoc` 库的 `SwaggerDefinition` 注释来定义 Swagger 规范。
```
/**
* @swagger
* definitions:
* User:
* properties:
* id:
* type: integer
* format: int64
* name:
* type: string
* email:
* type: string
* password:
* type: string
*/
/**
* @swagger
* /users:
* get:
* description: Get all users
* produces:
* - application/json
* responses:
* 200:
* description: An array of users
* schema:
* $ref: '#/definitions/User'
*/
```
3. 在代码中使用 `swagger-jsdoc` 库的 `swagger-jsdoc()` 方法来生成 Swagger 规范。
```
import swaggerJSDoc from 'swagger-jsdoc';
const options = {
swaggerDefinition: {
info: {
title: 'My API',
version: '1.0.0',
description: 'My API with Swagger',
},
basePath: '/',
},
apis: ['**/*.ts'],
};
const swaggerSpec = swaggerJSDoc(options);
```
4. 在代码中使用 `swagger-ui-express` 库的 `swaggerUi.setup()` 和 `swaggerUi.serve()` 方法来将 Swagger 文档集成到应用程序中。
```
import express from 'express';
import swaggerUi from 'swagger-ui-express';
const app = express();
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
```
这样,就可以在浏览器中访问 `/api-docs` 路径,查看生成的 Swagger 文档了。