写在最前

zxcloud集成了Swagger作为API生成与测试框架,zxcloud提供了自动化的配置,让您从繁琐的编码工作中解放出来,快速生成自己定制化的Swagger API文档。

快速使用

  • pom.xml中引入以下依赖:
  1. <dependency>
  2. <groupId>com.zhexun</groupId>
  3. <artifactId>zxcloud-common-swagger</artifactId>
  4. </dependency>
  • main 方法添加注解
@EnableZxcloudSwagger2

服务配置网关路由

nacos/zxcloud-gateway-dev.yml

若未配置,则 swagger-ui 右上角列表不选找到此服务

新增微服务接入Swagger - 图1

访问地址

注意必须是 zxcloud-gateway 访问

http://zxcloud-gateway:9999/swagger-ui/index.html

填写客户端信息

username/password : 对应 sys_user 表中信息

client_id/client_secret : test/test (系统自带无需校验验证码的客户端,可参考 [验证码配置章节] )
新增微服务接入Swagger - 图2