Swagger2入门

xin_7

于 2023-02-09 16:59:56 发布

阅读量111

点赞数

分类专栏：项目经验文章标签： java 开发语言

本文链接：https://blog.csdn.net/xin_7/article/details/128956343

版权

项目经验专栏收录该内容

10 篇文章 0 订阅

订阅专栏

一、Swagger2介绍

前后端分离开发模式中，api文档是最好的沟通方式。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)

规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)

一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)

可测性 (直接在接口文档上进行测试，以方便理解业务)

二、配置Swagger2

引入相关依赖

        <!--swagger-->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.7.0</version>
            </dependency>
            <!--swagger ui-->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.7.0</version>
            </dependency>

创建swagger的配置类

@Configuration
@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("网站-API文档")
                .description("本文档描述了接口定义")
                .version("1.0")
                .contact(new Contact("java", "http://xxx.com", "1111@qq.com"))
                .build();
    }
}