β

开源:API文档汇总管理工具Swagger Butler

程序猿DD | 博客 210 阅读

Swagger Butler是一个基于Swagger与Zuul构建的API文档汇集工具。通过构建一个简单的Spring Boot应用,增加一些配置就能将现有整合了Swagger的Web应用的API文档都汇总到一起,方便查看与测试。

项目地址

使用手册

快速入门

该工具的时候非常简单,先通过下面几步简单入门:

第一步 :构建一个基础的Spring Boot应用

如您还不知道如何创建Spring Boot应用,可以先阅读 本篇入门文章

第二步 :在pom.xml中引入依赖

@EnableSwaggerButler
@SpringBootApplication
public class StaticApplication {

public static void main(String[] args) {
SpringApplication.run(StaticApplication.class);
}

}

第四步 :配置文件中增加Swagger文档的地址配置

<dependencies>
<dependency>
<groupId>com.didispace</groupId>
<artifactId>swagger-butler-core</artifactId>
<version>1.0.0</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
<version>1.3.2.RELEASE</version>
</dependency>
</dependencies>

第二步 :应用主类增加 @EnableDiscoveryClient ,比如:

spring.application.name=swagger-butler-example-eureka
server.port=11001


eureka.client.service-url.defaultZone=http://eureka.didispace.com/eureka/

代码示例具体可见 swagger-butler-example-eureka 目录

与consul整合

在整合eureka获取所有该注册中心下的API文档时,只需要在上面工程的基础上增加下面的配置:

第一步 pom.xml 中增加 consul 依赖,比如:

@EnableDiscoveryClient
@EnableSwaggerButler
@SpringBootApplication
public class EurekaApplication {

public static void main(String[] args) {
SpringApplication.run(EurekaApplication.class);
}

}

第三步 :配置文件中增加eureka的配置,比如:

spring.application.name=swagger-butler-example-consul
server.port=11002

spring.cloud.consul.host=localhost
spring.cloud.consul.port=8500

代码示例具体可见 swagger-butler-example-consul 目录

推荐内容

贡献者

公众号

干货分享

Swagger Butler是一个基于Swagger与Zuul构建的API文档汇集工具。通过构建一个简单的Spring Boot应用,增加一些配置就能将现有整合了Swagger的Web应用的API文档都汇总到一起,方便查看与测试。

项目地址

作者:程序猿DD | 博客
Dream big, work smart, deliver fast
原文地址:开源:API文档汇总管理工具Swagger Butler, 感谢原作者分享。

发表评论