β

简化Swagger使用的自制Starter:spring-boot-starter-swagger,

Harries Blog™ 77 阅读

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

GitHub https :// git hub.com/dyc87112/spring-boot-s tar ter-swagger

http ://git.oschina.net/d id ispace/spring-boot-starter-swagger

博客 : http://blog.didispace.com

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

版本基础

  • 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.1.0.RELEASE</version>
</dependency>
  • 在应用主类中增加 @EnableSwagger2Doc
    注解
@EnableSwagger2Doc
@SpringBootApplication
public 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.x
swagger.version=1.1.0.RELEASE
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.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.title= 标题
  • swagger.descr ip tion=描述
  • 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-path
swagger.exclude-path
使用ANT规则配置。

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

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

management.context-path=/ops

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

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

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

如果您有任何想法或问题需要讨论或交流,可进入交流区发表您的想法或问题。

原文

http://blog.didispace.com/spring-boot-starter-swagger-1.1.0/

PS:如果您想和业内技术大牛交流的话,请加qq群(527933790)或者关注微信公众 号(AskHarries),谢谢!

转载请注明原文出处: Harries Blog™ » 简化Swagger使用的自制Starter:spring-boot-starter-swagger,欢迎使用和吐槽

作者:Harries Blog™
追心中的海,逐世界的梦

发表评论