Swagger技术

2022-08-18 106 阅读1分钟

Swagger技术

Swagger官网:

Swagger的作用与概念

在前后端分离时代，我们需要实时自动更新接口信息，和测试接口，实现前后端分离式开发，swagger因此产生

swagger优点

号称时最流行的 API 框架
接口文档在线生成，避免同步的麻烦
可以支持在线对接口执行测试
支持多语言

SpringBoot集成swagger

1.引入依赖

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
</dependency>
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.9.2</version>
</dependency>

2.搭建配置类

EM552H}TGG6C3Y0C%P4~T8C.png

OQFD@2U~DQX3CCAM7}ZYJCS.png

2.1.启动配置类

![OBHC60.png

2.2.运行

F~N0.png

3.接口类搭建

PMA5Z8YY2A`XG5AOH6MBPR6.png

5R1UUXM9T`VG4)CUGUZ9B.png

3.1用户登录接口模块

![}{GOM3WGGQ5XT9`313JIUA.png

$7W(7%`}_{29LO{E4HMWO6@I.png$

![@P1O98JQA55CA3OP78}G.png

3.2理解方法的作用

`$7SPNIXG)NKN34})9%R)QM.png

3.3对接口中具体方法的参数的描述

}S{~8QXN(SRP(@L3JXST5}K.png

3.3.1对之前代码进行注释

![AUGK_OIL)6JVZD})D$BTMQ.png

6RPF%[62YCI3QV2XO8Y7H]K.png

![8BJIS6ALX{_7NKL(62@$`X.png

4以对象方式进行生成

创建实体类 以json****格式传过来的数据 要加@RequestBody****注解

1}HS(P}A81@WNBYD}RC.png

![Q0TM5VRYCR]MLJE0`K)X18I.png](p3-juejin.byteimg.com/tos-cn-i-k3…?)

5.针对响应方面

YG}0CP_QV6V648BZ}2X_D}V.png

![Q]T21U3 $2$ D$128T}U2WMT.png