安装swagger

链接: link
1.打开vscode，在终端输入：

npm install --save @nestjs/swagger swagger-ui-express

应用swagger

1.打开入口文件main.ts，在引用里面加入

import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';

2.打开入口文件main.ts，在引用里面加入

 const config = new DocumentBuilder().setTitle('Cats example').setDescription('The cats API description').setVersion('1.0').addTag('cats').build();const document = SwaggerModule.createDocument(app, config);SwaggerModule.setup('api', app, document);

3.上面的引用来自于官网，我们需要进行三处更改，如下更改，

（1）建立自己的标题，可以自选
（2）添加描述，自选描述
（3）更改接口文档名字，建议更改，默认为api,会影响多个api的路径

4.在终端输入

npm run start:dev

等待程序运行，运行后打开
打开地址http://localhost:3000/api-docs/，如下图。发现接口文档已经出来了

5.上图中Get到根路径：就是我们app.controller.ts里面的内容,打开app.controller.ts
加入代码：

@ApiTags('默认')
export class AppController {

6.打开地址http://localhost:3000/api-docs/，如下图。发现根接口文档已经被分离出来了，然后并且加上了默认的标签。

7.如法炮制，在posts.controller.ts中输入代码

@ApiTags('帖子')

8.打开地址http://localhost:3000/api-docs/，如下图。发现post接口文档已经被分离出来了，然后并且加上了帖子的标签。

添加描述

1.在posts.controller.ts中输入代码

@ApiOperation({summary:'显示博客列表'})

2.打开地址http://localhost:3000/api-docs/，如下图。发现post接口文档已经添加了项目描述

测试

1.点击GET，再点击try it out

2.点击execute,里面会出现具体响应。

举一反三

1.在posts.controller.ts中输入代码

2.点击execute,查看响应

使用Swagger自动生成接口文档相关推荐

Swagger - 自动生成接口文档
Swagger Swagger可以很方便的直接生成项目的接口,便于前后端的分离式开发,并且它还具备调试等功能,可以说十分方便.以这篇文章记录一些Swagger在Springboot项目开发中的使用. ...
DRF 自动生成接口文档
Python微信订餐小程序课程视频 https://edu.csdn.net/course/detail/36074 Python实战量化交易理财系统 https://edu.csdn.net/cou ...
idea swagger生成接口文档_Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据...
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
java自动生成接口文档
java自动生成接口文档 maven依赖工具类展示效果首页接口页在平时的开发过程中必定要写接口文档作为程序员最烦的2件事 1.别人让你写接口文档 2.接手别人的项目没有接口文档由此可见 ...
SpringBoot自动生成接口文档
跟大家介绍一个自动生成接口文档的工具包,作者的理念是注释即文档,在写代码的时候写上注释,项目启动后就会生成接口文档,非常方便,省去了Swagger写注解的过程. 仓库地址:https://github ...
Swagger的生成接口文档
Swagger的生成接口文档一.背景前后端之间约定好使用Restful风格的API进行数据通信,此时如果我们能够提供一份清晰明了的接口文档,能够极大的提高效率,既满足我们输出文档的需要又能随代码的 ...
自动生成接口文档之JApiDocs教程
JApiDocs教程前言作为一名优秀的程序员来说,由于涉及到要与前端进行对接,所以避免不了的就是写接口文档.写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我 ...
swagger自动创建接口文档用法
现在的开发大部分都是前后端分离的模式了,后端提供接口,前端调用接口.后端提供了接口,需要对接口进行测试,之前都是使用浏览器开发者工具,或者写单元测试,再或者直接使用Postman,但是现在这些都已经o ...

使用Swagger自动生成接口文档

安装swagger

应用swagger

添加描述

测试

举一反三

使用Swagger自动生成接口文档相关推荐

最新文章

热门文章