springboot学习日记(四)

发布时间 2023-11-17 02:08:49作者: 真是傑作呢

这里我试了下把swagger加入到项目中去,这是一个方便设计各种api接口的工具,首先配置依赖,然后加入config文件,注解@Configuration提醒springboot加载配置类,注解@EnableSwagger2是启动Swagger2.

可以在pojo类中加入@ApiModel("XX类")用于描述数据模型的信息,在属性前加上@ApiModelProperty("XXXX")用于描述数据模型属性信息。

通过在Controller类上添加@Api注解,可以给控制器增加描述和标签信息,@API用于描述整个 API 或 API 分组的信息。在方法前(比如GetMapping)@ApiOperation,用于描述单个接口操作的信息。

这边记录下docket类。

Docket 是 Swagger 框架中的一个核心类,用于配置和构建 Swagger 的文档对象模型(Document Object Model)。

Docket 类位于 springfox-swagger 模块中,是一个用于配置 Swagger 的构建器(Builder)类。它提供了各种方法来配置 Swagger 的属性和规则,用于生成 API 文档。

API 选择:设置要包含在 Swagger 文档中的 API 的选择规则,例如扫描的基本包路径、路径匹配规则等。
API 信息:设置 Swagger 文档的基本信息,如标题、描述、版本等。
API 分组:支持将 API 按逻辑分组,每个分组有自己的文档页。
API 接口过滤:设置要排除的 API 接口,以及可显示的 API 接口。
全局参数:设置全局的请求参数,这些参数将适用于所有的 API 接口。
安全配置:设置接口的安全要求,如使用 OAuth、JWT 等身份验证机制。
全局响应消息:设置全局的响应消息,用于描述常见的响应状态和错误信息。——————————chatgpt