02.06 Swagger 文档配置

swagger3注解

• https://blog.csdn.net/qq_35425070/article/details/105347336

快速使用

在需要swagger的服务pom.xml中引入，为保证性能和安全性正式环境建议取消此pom引入和注解，只在开发时使用swagger

    <dependency>
        <groupId>com.joolun</groupId>
        <artifactId>joolun-common-swagger</artifactId>
    </dependency>

启动类中增加@EnableSwagger注解

@EnableSwagger
@SpringCloudApplication
@EnableBaseFeignClients
@EnableBaseResourceServer
public class BaseWeiXinApplication {

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

配置（application-dev.yml）

• 无需改动

springdoc:
  info:
    title: JooLun-pro API
    description: JooLun快速开发平台-采用目前最流行的微服务前后端分离框架
    version: 1.0
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'default'
      paths-to-match: '/**'
      packages-to-scan: com.joolun.cloud

配置（joolun-gateway-dev.yml）

• 无需改动

# knife4j 网关聚合
knife4j:
  gateway:
    enabled: true
    # 指定服务发现的模式聚合微服务文档，并且是默认 default 分组
    strategy: discover
    discover:
      enabled: true
      # OpenAPI 3.0 规范 
      version: openapi3
      # 不需要文档服务的微服务
      excluded-services:
        - joolun-auth

访问文档

• http://joolun-gateway:9999/doc.html

文档查看及调试

• 后台查看接口文档

• 调试接口

1. 开启动态请求参数

1. 登录后台复制出token用来调试，同埋商城端复制出session用来调试

参考资料

• https://doc.xiaominfo.com/docs/blog/gateway/knife4j-gateway-introduce