springboot 接口文档

2023-12-13 23:50:28

swagger 特点： 遵循openAPI 实时更新

在这里插入图片描述
1.导入依赖

org.springdoc
springdoc-openapi-starter-webmvc-ui
2.1.0

2.访问验证
http://localhost:xxxx/swagger-ui/index.html
在这里插入图片描述

3.增加controller描述
controller类上@Tag

在这里插入图片描述
在这里插入图片描述

4.增加方法描述

@Operation（）
在这里插入图片描述

在这里插入图片描述
5.增加参数说明
在这里插入图片描述
在这里插入图片描述
6.对响应字段进行说明
在这里插入图片描述

在这里插入图片描述
7.接口分类展示
在这里插入图片描述
在这里插入图片描述

8.docs文档分类设置

在这里插入图片描述

在这里插入图片描述

文章来源:https://blog.csdn.net/qq_41170818/article/details/134840929
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。