swagger使用笔记_2022/3/3

---

前言

本文主要记录swagger页面的使用
感谢liangsir教我

---

一、我对swagger的浅显理解

swagger可以通过注解自动生成接口文档
常用注解：
1.用于类，表示这个类是swagger资源，在下图左侧显示：商品参数.操作接口

@Api(value = "商品参数." , tags = {"商品参数.操作接口"})

2.用于方法，表示这是一个http请求的操作

@ApiOperation("添加")

3.用于类 ；表示对类进行说明，参数用实体类接收

@ApiModel()

4.用于方法和字段，表示对model属性的说明或者数据操作更改

 @ApiModelProperty(value = "款式.", example = "1")

5.用于方法，参数，字段说明；表示对参数的添加元数据

@ApiParam()

6.用于方法，表示单独的请求参数

@ApiImplicitParam(
        name = "ids",
        value = "ID列表",
        paramType = "query",
        required = true,
        example = "1,2,3"
    )

7.用于方法，包含多个 @ApiImplicitParam

@ApiImplicitParams()

二、使用步骤

1.访问swagger页面

• url:http://localhost:端口号/doc.html

2.按照下图操作

auth-center-web --> 用户名登录2 --> 调试 --> 请求头部{把请求头的选中状态都取消} --> 请求参数{设置用户密码} -->发送 --> 得到token_type和access_token

3.操作访问自己写的接口

在请求头部填入token_type和access_token(中间得有一个空格) --> 设置请求参数(得按照controller的方法参数来写) --> 发送 --> 得到响应结果

---

其它

1.项目的名称是网关服务里面配置的，如下图id号