Swagger的配置

java小豪

已于 2022-03-06 23:25:24 修改

阅读量1.2k

点赞数

分类专栏：视频笔记文章标签：学习 spring boot

于 2022-03-05 23:16:00 首次发布

本文链接：https://blog.csdn.net/qq_51929833/article/details/123303207

版权

视频笔记专栏收录该内容

19 篇文章 6 订阅

订阅专栏

本文介绍了如何在项目中集成Swagger，通过添加Maven依赖和配置Swagger类，实现API的文档化。Swagger是一个用于生成、描述和交互RESTful服务的框架，帮助开发者保持API与客户端的同步，并提供可视化的API接口。

摘要由CSDN通过智能技术生成

Swagger的配置

swagger概述
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法/参数/模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

一、添加maven依赖

<!--配置swagger-->
    <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger2</artifactId>
       <version>2.9.2</version>
    </dependency>
    <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger-ui</artifactId>
       <version>2.9.2</version>
    </dependency>

二、添加swagger配置类

@Configuration
// Swagger注解
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi") // 文档的分组名称
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }
    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("********") // 文档的题头
                .description("*******") //文档的描述 
                .version("1.0")
                .contact(new Contact("Helen", "https://*****.com", "55317332@qq.com"))
                .build();
    }
}
```