diff --git a/clients/java/wcferry-mvn/README.MD b/clients/java/wcferry-mvn/README.MD index 92194a6..2d4136e 100644 --- a/clients/java/wcferry-mvn/README.MD +++ b/clients/java/wcferry-mvn/README.MD @@ -55,6 +55,8 @@ wcferry: 启动后springboot自身的端口为 9201 socket的端口为 10086 +swagger地址:http://localhost:9201/swagger-ui/index.html + ## 参与开发 ### 核心依赖 diff --git a/clients/java/wcferry-mvn/pom.xml b/clients/java/wcferry-mvn/pom.xml index 16f0a96..e4d8458 100644 --- a/clients/java/wcferry-mvn/pom.xml +++ b/clients/java/wcferry-mvn/pom.xml @@ -25,6 +25,11 @@ org.springframework.boot spring-boot-starter-web + + org.springframework.boot + spring-boot-starter-test + test + org.slf4j @@ -37,6 +42,12 @@ 1.18.30 provided + + + io.springfox + springfox-boot-starter + 3.0.0 + com.google.protobuf diff --git a/clients/java/wcferry-mvn/src/main/java/com/iamteer/config/SwaggerConfig.java b/clients/java/wcferry-mvn/src/main/java/com/iamteer/config/SwaggerConfig.java new file mode 100644 index 0000000..3881665 --- /dev/null +++ b/clients/java/wcferry-mvn/src/main/java/com/iamteer/config/SwaggerConfig.java @@ -0,0 +1,44 @@ +package com.iamteer.config; + +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import springfox.documentation.builders.ApiInfoBuilder; +import springfox.documentation.builders.PathSelectors; +import springfox.documentation.builders.RequestHandlerSelectors; +import springfox.documentation.oas.annotations.EnableOpenApi; +import springfox.documentation.service.ApiInfo; +import springfox.documentation.spi.DocumentationType; +import springfox.documentation.spring.web.plugins.Docket; + +/** + * 配置类-swagger + * http://localhost:9201/swagger-ui/index.html + * + * @author chandler + * @date 2024-09-24 22:13 + */ +@EnableOpenApi +@Configuration +public class SwaggerConfig { + + @Bean + public Docket api() { + return new Docket(DocumentationType.SWAGGER_2).select() + // 替换为您的Controller所在的包路径 + .apis(RequestHandlerSelectors.basePackage("com.iamteer.controller")) + // 地址 + .paths(PathSelectors.any()).build().apiInfo(apiInfo()); + } + + private ApiInfo apiInfo() { + return new ApiInfoBuilder() + // 文档标题 + .title("Wcferry接口文档") + // 文档路径 + .description("微信机器人底层框架接口文档") + // 文档版本 + .version("1.0.0").build(); + } + +} diff --git a/clients/java/wcferry-mvn/src/main/resources/application.yml b/clients/java/wcferry-mvn/src/main/resources/application.yml index d0089c3..0b3ff26 100644 --- a/clients/java/wcferry-mvn/src/main/resources/application.yml +++ b/clients/java/wcferry-mvn/src/main/resources/application.yml @@ -10,6 +10,10 @@ spring: application: # 应用名 name: wcferry-mvn + # swagger适配 + mvc: + pathmatch: + matching-strategy: ant_path_matcher # 本服务参数 wcferry: