小满nestjs（第二十三章 nestjs swagger接口文档）

swagger 用于提供给前端接口文档

安装命令如下

npm install  @nestjs/swagger swagger-ui-express

在main.ts 注册swagger

async function bootstrap() {const app = await NestFactory.create<NestExpressApplication>(AppModule);const options = new DocumentBuilder().setTitle('小满接口文档').setDescription('描述，。。。').setVersion('1').build()const document = SwaggerModule.createDocument(app,options)SwaggerModule.setup('/api-docs',app,document)await app.listen(3000);
}
bootstrap();

打开对应的路径即可

现在发现并没有分组很乱

可以使用ApiTags 添加分组

ApiOperation 接口描述

  @Get()@Role('admin')@ApiOperation({summary:"测试admin",description:"请求该接口需要amdin权限"})findAll(@ReqUrl('123') url:string) {console.log(url,'url')return this.guardService.findAll();}

ApiParam 动态参数描述

@ApiParam({name:"id",description:"用户id",required:true})

ApiQuery 修饰get

 @ApiQuery({name:"xxxx",description:"bbb"})

ApiProperty 定义Post

import { ApiProperty } from "@nestjs/swagger"export class CreateGuardDto {@ApiProperty({ description: "姓名", example: "小满" })name: string@ApiProperty({ description:"年龄"})age: number
}

ApiResponse 自定义返回信息

@ApiResponse({status:403,description:"自定义返回信息"})

ApiBearerAuth jwt token

main.ts 增加 addBearerAuth()

添加token

请求头携带了

其他装饰器

小满nestjs（第二十三章 nestjs swagger接口文档）相关推荐

python实现处理swagger接口文档，转换为yaml格式的自动化用例
前言之前有很多小伙伴反馈,希望我出一期将swagger文档转换为 yaml格式的自动化用例,那么本期福利来咯~~这一篇文档,将会带领你们实现如何通过 swagger文档转换为 yaml格式的用例 ...
【愚公系列】2023年02月 WMS智能仓储系统-007.Swagger接口文档的配置
文章目录前言一.Swagger接口文档的配置 1.安装包 2.注入 2.1 Swagger服务的注入 2.2 appsetting.json的配置 2.3 Swagger服务的封装 2.3.1 S ...
sentinel 官方文档_SpringCloud网关聚合Swagger接口文档实践
目前大多数项目都是以微服务架构设计,以前后端分离技术解耦前端开发工程师和后端开发工程师的工作量,这样一来前后端的对接将是一项重要的沟通工作量,如果后端没有一个合适的API文档,那么这样的前后端对接将是 ...
swagger接口文档使用
swagger接口文档一,swagger简介前后端分离 swagger 诞生二,springboot集成swagger 依赖编写helloworld接口配置swagger ==> co ...
springboot 接口文档请求 enum_Spring Boot集成SpringFox 3：生成Swagger接口文档
SpringFox介绍 SpringFox是一个开源的API Doc的框架, 它的前身是swagger-springmvc,可以将我们的Controller中的方法以文档的形式展现.官方定义为:Aut ...
整合Swagger接口文档
Swagger接口文档:自动生成接口文档 1.添加依赖: <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagg ...
自动生成python接口文档_Django自动生成Swagger接口文档
Django自动生成Swagger接口文档 1. 前言当接口开发完成,紧接着需要编写接口文档.传统的接口文档通常都是使用Word或者一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次 ...
swagger接口文档出现的空文档问题
记一次使用swagger接口文档出现的空文档问题问题描述: 上面显示的一些空文档下面的才是真正的正确文档: 最终尝试发现问题: 原因:**@Api(value = "ExamPaperC ...
SpringBoot集成knife4j实现Swagger接口文档
前言:如果你是后台开发,提供restful接口给前端,建议你使用Swagger3提供restful的接口文档自动生成和在线接口调试.knife4j是对Swagger进一步封装,其优化了API文档的UI ...
Python Swagger 接口文档自动集成平台
一安装当前virtualenv 环境下 pip install django-rest-swagger==2.2.0 在Django项目settings.py中加入插件模块 DEBUG = T ...

小满nestjs（第二十三章 nestjs swagger接口文档）

在main.ts 注册swagger

可以使用ApiTags 添加分组

ApiOperation 接口描述

ApiParam 动态参数描述

ApiQuery 修饰get

ApiProperty 定义Post

ApiResponse 自定义返回信息

ApiBearerAuth jwt token

其他装饰器

小满nestjs（第二十三章 nestjs swagger接口文档）相关推荐

最新文章

热门文章