专栏首页程序猿DDspring-boot-starter-swagger 1.2.0.RELEASE:新增分组配置功能

spring-boot-starter-swagger 1.2.0.RELEASE:新增分组配置功能

简介

该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档,简化原生使用swagger2的整合代码。

  • GitHub:https://github.com/dyc87112/spring-boot-starter-swagger
  • 码云:http://git.oschina.net/didispace/spring-boot-starter-swagger
  • 博客:http://blog.didispace.com

版本基础

  • Spring Boot:1.5.x
  • Swagger:2.7.x

如何使用

在该项目的帮助下,我们的Spring Boot可以轻松的引入swagger2,主需要做下面两个步骤:

  • pom.xml中引入依赖:
<dependency>    
  <groupId>com.didispace</groupId>    
  <artifactId>spring-boot-starter-swagger</artifactId>    
  <version>1.2.0.RELEASE</version>
</dependency>
  • 在应用主类中增加 @EnableSwagger2Doc注解
@EnableSwagger2Doc
@SpringBootApplicationpublic class Bootstrap {
    public static void main(String[] args) {        
      SpringApplication.run(Bootstrap.class, args);   
    }
}

默认情况下就能产生所有当前Spring MVC加载的请求映射文档。

参数配置

更细致的配置内容参考如下:

配置示例

swagger.title=spring-boot-starter-swagger
swagger.description=Starter for swagger 2.xswagger.version=1.1.0.RELEASEswagger.license=Apache License, Version 2.0swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.htmlswagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swaggerswagger.contact.name=didiswagger.contact.url=http://blog.didispace.comswagger.contact.email=dyc87112@qq.comswagger.base-package=com.didispaceswagger.base-path=/**swagger.exclude-path=/error, /ops/**

配置说明

默认配置

- swagger.title=标题- swagger.description=描述- swagger.version=版本- swagger.license=许可证- swagger.licenseUrl=许可证URL- swagger.termsOfServiceUrl=服务条款URL- swagger.contact.name=维护人- swagger.contact.url=维护人URL- swagger.contact.email=维护人email- swagger.base-package=swagger扫描的基础包,默认:全扫描- swagger.base-path=需要处理的基础URL规则,默认:/**- swagger.exclude-path=需要排除的URL规则,默认:空

Path规则说明

swagger.base-pathswagger.exclude-path使用ANT规则配置。

我们可以使用 swagger.base-path来指定所有需要生成文档的请求路径基础规则,然后再利用 swagger.exclude-path来剔除部分我们不需要的。

比如,通常我们可以这样设置:

management.context-path=/opsswagger.base-path=/**swagger.exclude-path=/ops/**, /error

上面的设置将解析所有除了 /ops/开始以及spring boot自带 /error请求路径。

其中, exclude-path可以配合 management.context-path=/ops设置的spring boot actuator的context-path来排除所有监控端点。

分组配置

当我们一个项目的API非常多的时候,我们希望对API文档实现分组。从1.2.0.RELEASE开始,将支持分组配置功能。

具体配置内容如下:

- swagger.docket.<name>.title=标题- swagger.docket.<name>.description=描述- swagger.docket.<name>.version=版本- swagger.docket.<name>.license=许可证- swagger.docket.<name>.licenseUrl=许可证URL- swagger.docket.<name>.termsOfServiceUrl=服务条款URL- swagger.docket.<name>.contact.name=维护人- swagger.docket.<name>.contact.url=维护人URL- swagger.docket.<name>.contact.email=维护人email- swagger.docket.<name>.base-package=swagger扫描的基础包,默认:全扫描- swagger.docket.<name>.base-path=需要处理的基础URL规则,默认:/**- swagger.docket.<name>.exclude-path=需要排除的URL规则,默认:空

说明: <name>为swagger文档的分组名称,同一个项目中可以配置多个分组,用来划分不同的API文档。

分组配置示例

swagger.docket.aaa.title=group-aswagger.docket.aaa.description=Starter for swagger 2.xswagger.docket.aaa.version=1.2.0.RELEASEswagger.docket.aaa.termsOfServiceUrl=https://gitee.com/didispace/spring-boot-starter-swaggerswagger.docket.aaa.contact.name=zhaiyongchaoswagger.docket.aaa.contact.url=http://spring4all.com/swagger.docket.aaa.contact.email=didi@potatomato.clubswagger.docket.aaa.excludePath=/ops/**swagger.docket.bbb.title=group-bbbswagger.docket.bbb.basePackage=com.yonghui

说明:默认配置与分组配置可以一起使用。在分组配置中没有配置的内容将使用默认配置替代,所以默认配置可以作为分组配置公共部分属性的配置。

本文分享自微信公众号 - 程序猿DD(didispace),作者:翟永超

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2017-08-20

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 简化Swagger使用的自制Starter:spring-boot-starter-swagger,欢迎使用和吐槽

    项目简介 该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档,简化原生使用swag...

    程序猿DD
  • spring-boot-starter-swagger迎新伙伴支持,加速更新进度(1.3.0.RELEASE)

    从该starter创建至今收到了不少使用反馈,同时也有不错的童鞋申请加入一起维护。本篇先欢迎小火童鞋的加入及贡献,接下来具体说说本次的更新内容。 本次更新主要新...

    程序猿DD
  • Spring Cloud Zuul中使用Swagger汇总API接口文档

    之前给大家的回复都只是简单的说了个思路,昨天正好又有人问起,索性就举个例子写成博文供大家参考吧。

    程序猿DD
  • Swagger-UI

    顾翔老师开发的bugreport2script开源了,希望大家多提建议。文件在https://github.com/xianggu625/bug2testscr...

    小老鼠
  • 基于SpringCloud的Microservices架构实战案例-在线API管理

    前端和后端的唯一联系,变成了API接口;API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架。 本实战...

    歪脖贰点零
  • SpringBoot结合swagger2快速生成简单的接口文档

    经我多次尝试application.properties中不加任何swagger配置也可生成文档进行正常测试

    道可道非常道
  • spring-boot-starter-swagger迎新伙伴支持,加速更新进度(1.3.0.RELEASE)

    从该starter创建至今收到了不少使用反馈,同时也有不错的童鞋申请加入一起维护。本篇先欢迎小火童鞋的加入及贡献,接下来具体说说本次的更新内容。 本次更新主要新...

    程序猿DD
  • 简化Swagger使用的自制Starter:spring-boot-starter-swagger,欢迎使用和吐槽

    项目简介 该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档,简化原生使用swag...

    程序猿DD
  • Spring Boot中使用Swagger CodeGen生成REST client

    Spring Boot中使用Swagger CodeGen生成REST client

    程序那些事
  • 5分钟了解swagger

    随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。

    互扯程序

扫码关注云+社区

领取腾讯云代金券