@ApiBody({ type: UpdateWsPointParams }) 显示注释怎么弄
时间: 2023-06-24 19:04:46 浏览: 159
在使用 Swagger 生成 API 文档时,可以通过在代码中添加注释来指定请求体的类型。具体步骤如下:
1. 在代码中添加注释,指定请求体的类型,例如:
```
/**
* 更新 WebSocket 连接的坐标信息
* @param {UpdateWsPointParams} params - 请求参数
*/
@ApiTags('WebSocket')
@Patch('update-ws-point')
@ApiBody({ type: UpdateWsPointParams })
async updateWsPoint(@Body() params: UpdateWsPointParams): Promise<void> {
// 处理逻辑
}
```
2. 在 `tsconfig.json` 中开启 `emitDecoratorMetadata`,例如:
```
{
"compilerOptions": {
...
"emitDecoratorMetadata": true,
...
}
}
```
3. 在使用 Swagger 生成 API 文档时,需要使用支持读取装饰器元数据的工具,例如 `@nestjs/swagger`。在 `main.ts` 中添加以下代码:
```
import { NestFactory } from '@nestjs/core';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { AppModule } from './app.module';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
const options = new DocumentBuilder()
.setTitle('API 文档')
.setDescription('API 文档')
.setVersion('1.0')
.addTag('WebSocket')
.build();
const document = SwaggerModule.createDocument(app, options);
SwaggerModule.setup('api-doc', app, document);
await app.listen(3000);
}
bootstrap();
```
4. 在浏览器中访问 `http://localhost:3000/api-doc`,即可查看生成的 API 文档。在请求体中,会显示注释中指定的数据类型。
阅读全文
相关推荐
![docx](https://img-home.csdnimg.cn/images/20241231044901.png)
![zip](https://img-home.csdnimg.cn/images/20241231045053.png)
![docx](https://img-home.csdnimg.cn/images/20241231044901.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)