Swagger基础配置

最新推荐文章于 2024-04-18 17:32:30 发布

一叶知秋~~~

最新推荐文章于 2024-04-18 17:32:30 发布

阅读量441

点赞数 1

分类专栏： java配置文章标签：接口

本文链接：https://blog.youkuaiyun.com/weixin_48948487/article/details/108179161

版权

java配置专栏收录该内容

5 篇文章

订阅专栏

(一)Swagger2介绍

前后端分离开发模式中，api文档是最好的沟通方式。
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
1.及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)
2.规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)
3.一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)
4.可测性 (直接在接口文档上进行测试，以方便理解业务)

(二)Swagger2配置

引入依赖

   <!--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>

导入配置类

@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("Helen", "http://baidu.com", "123456@qq.com"))
                .build();
    }
}