fxbin / swagger-spring-boot-starter

自制 swagger spring-boot-starter, 默认集成 knife4j, 界面更加友好,同时使用便捷, 一键集成sringboot 项目,同时支持一键开启网关聚合功能,使你解脱书写、配置API文档的烦恼...

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

swagger-spring-boot-starter

Codacy Badge Spring Boot Spring Cloud Knife4j

自制 swagger spring-boot-starter, 默认集成 knife4j, 界面更加友好,同时使用便捷,一键集成sringboot 项目,
同时支持一键开启网关聚合功能,使你解脱书写、配置Swagger API文档的烦恼...
依赖 版本
Spring Boot 2.5.3
Spring Cloud 2020.0.3
Knife4j 3.0.3
  • 注意: 笔者仅测试过如上版本的使用情况,低版本请自行测试

使用步骤

PS: 最新版为1.4

  1. 添加 maven 依赖
<dependency>
    <groupId>cn.fxbin.swagger</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>${currentVersion}</version>
</dependency>

PS: 已发布**仓库,可直接引用

  1. 修改配置文件
spring:
  swagger:
    enabled: true

  # 如果使用 2.6.X 以上版本,需增加如下配置,否则不生效
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

更多配置属性参考:

配置属性

其它注意事项

与网关集成时,默认按照 spring.cloud.gateway.discovery.locator.enabled 配置项来决定是否开启动态文档,默认读取文件配置

参考文档

knife4j doc

About

自制 swagger spring-boot-starter, 默认集成 knife4j, 界面更加友好,同时使用便捷, 一键集成sringboot 项目,同时支持一键开启网关聚合功能,使你解脱书写、配置API文档的烦恼...

License:Apache License 2.0


Languages

Language:Java 100.0%