天天看点

简化Swagger使用的自制Starter:spring-boot-starter-swagger,欢迎使用和吐槽项目简介版本基础如何使用参数配置

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

小工具一枚,欢迎使用和Star支持,如使用过程中碰到问题,可以提出Issue,我会尽力完善该Starter

Spring Boot:1.5.x

Swagger:2.7.x

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

在<code>pom.xml</code>中引入依赖:

在应用主类中增加<code>@EnableSwagger2Doc</code>注解

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

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

配置示例

配置说明

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规则,默认:空

<code>swagger.base-path</code>和<code>swagger.exclude-path</code>使用ANT规则配置。

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

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

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

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