Spring boot 接入swagger以及使用

Posted 2023-04-27

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring boot 接入swagger以及使用相关的知识，希望对你有一定的参考价值。

参考技术A

Springboot 集成Swagger 2（springfox）

Springfox Swagger2:

Springfox Swagger UI:

创建一个以上一个类配置swagger即可。

访问界面：IP:port/swagger-ui.html

在以上配置类中添加方法：

项目中并不需要swagger将整个项目的所有类暴露出去，通过以上配置的Bean实例，设置swagger关注并显示的接口，以及是否开启使用：

只希望在开发环境中使用swagger，但是生产环境不使用：

配置API文档分组：

配置多个分组：

在配置类中，一个Docket Bean实例，对应一个swagger分组。

@Api的属性

示例：

@ApiModel的属性：

@ApiModelProperty的属性说明：

示例：

如何使用 YAML 文件在 Spring Boot 中配置 Swagger？

【中文标题】如何使用 YAML 文件在 Spring Boot 中配置 Swagger？【英文标题】：How to configure Swagger in Spring Boot using YAML file? 【发布时间】：2018-11-29 12:41:31 【问题描述】：

我的 Swagger 配置有问题。现在 Swagger 正在扫描包并创建漂亮的文档，但我想使用我的 YAML（如果无法使用 YAML，则使用 JSON）文件。

这是我的 Swagger 配置类：

@Configuration
@EnableSwagger2
public class SwaggerConfig 
@Bean
public Docket api() 
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.myapp.rest"))
            .paths(PathSelectors.any())
            .build();

我想在 YAML 文件中编写使用示例，以便 Swagger 可以显示它们。如何更改/添加配置让 Swagger 获取我的 YAML 文件？

【问题讨论】：

【参考方案1】：

您可以下载 Swagger UI 并将其放置在您的项目中，将 URL 更改为指向 YAML 文件。