该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档,简化原生使用swagger2的整合代码。
小工具一枚,欢迎使用和Star支持,如使用过程中碰到问题,可以提出Issue,我会尽力完善该Starter
在该项目的帮助下,我们的Spring Boot可以轻松的引入swagger2,主需要做下面两个步骤:
pom.xml
中引入依赖:<dependency>
<groupId>com.didispace</groupId>
<artifactId>spring-boot-starter-swagger</artifactId>
<version>1.1.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.RELEASE
swagger.license=Apache License, Version 2.0swagger.license
Url=https://www.apache.org/licenses/LICENSE-2.0.htmls
wagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=程序猿DD
swagger.contact.url=http://blog.didispace.com
swagger.contact.email=dyc87112@qq.com
swagger.base-package=com.didispace
swagger.base-path=/**swagger.exclude-path=/error, /ops/**
配置说明
swagger.base-path
和 swagger.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来排除所有监控端点。