Spring Cloud Zuul中使用Swagger汇总API接口文档

本文介绍了如何在Spring Cloud Zuul中结合Swagger,实现API接口文档的汇总。首先,展示了如何在微服务中配置Swagger,然后在API网关上整合各个服务的Swagger文档,最后通过测试验证了文档的正确性和可用性。此外,还提供了Kafka实战笔记的概览。
摘要由CSDN通过智能技术生成

org.springframework.cloud

spring-cloud-dependencies

Dalston.SR1

pom

import

  • 第二步:编写应用主类:

@EnableSwagger2Doc

@EnableDiscoveryClient

@SpringBootApplication

public class Application {

public static void main(String[] args) {

new SpringApplicationBuilder(Application.class).web(true).run(args);

}

@RestController

class AaaController {

@Autowired

DiscoveryClient discoveryClient;

@GetMapping(“/service-a”)

public String dc() {

String services = "Services: " + discoveryClient.getServices();

System.out.println(services);

return services;

}

}

}

其中,@EnableSwagger2Doc注解是我们自制Swagger Starter中提供的自定义注解,通过该注解会初始化默认的Swagger文档设置。下面还创建了一个通过Spring MVC编写的HTTP接口,用来后续在文档中查看使用。

  • 第三步:设置配置文件内容:

spring.application.name=swagger-service-a

server.port=10010

eureka.client.serviceUrl.defaultZone=http://eureka.didispace.com/eureka/

swagger.base-package=com.didispace

其中,eureka服务端的配置采用了本站的公益eureka,大家可以通过http://eureka.didispace.com/查看详细以及使用方法。另外,swagger.base-package参数制定了要生成文档的package,只有com.didispace包下的Controller才会被生成文档。

注意:上面构建了swagger-service-a服务,swagger-service-b服务可以如法炮制,不再赘述。<

  • 22
    点赞
  • 20
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值