前后端分离时,前端对
接口都需要有
接口文档,根据
接口文档写
接口方法,看文档还要去写
接口方法基本都是粘贴复制,把这个机械的任务解除了
我们可以根据
swagger接口文档,前端来自动生成
接口方法
根据
swagger.
json文件来npm 生成
接口方法
接口信息都截去了
原创文章 60获赞 17访问量 21万+
<groupId>io.springfox</groupId>
<artifactId>springfox-
swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
1 @API
作用于类,放置于controller的一个类上,标志这个类是
Swagger资源。资源影响
Swagger的根文档、资源列表和该特定资源的API声明。
swagger将只包含和声明使用@Api注释的类,而忽略其他资源(servlet等)
1.1
参数
参数名称
主要是为了让一个实体可以用于不同的接口展示不同的字段,减少dto的数量,但是不宜过度使用,不然代码就被注解占满了
@ApiGroupProperty(value={GroupsUser.Update.class},description="")用于给Model字段分组,value控制所属组,description可以设置不同的字段描述
@ApiGroupProperties(value = {@ApiGroupProperty({)}})可以包含多个@ApiGroupProperty以便给不同分组的Mo
1. 在
Swagger的API文档
中找到相应的请求
接口。
2. 点击该
接口,在右侧的
参数列表
中找到带有@RequestBody注解的
参数。
3. 点击
参数旁边的“Model”按钮,以展开请求
参数的模型。
4. 在模型
中填写要发送的请求
参数数据。可以使用
JSON格式来填写。
5. 点击“Try it out”按钮来发送请求并查看响应结果。
注意事项:
- 确保请求
参数的数据类型和格式与
接口定义一致。
- 如果请求
参数是复杂对象,可以使用嵌套的
JSON格式来填写。
- 如果
接口定义了其他类型的
参数(例如路径
参数或查询
参数),也需要相应地填写。
通过以上步骤,你可以在
Swagger中测试带有@RequestBody
参数的请求,并查看相应的响应结果。