diff --git a/qiniu/pom.xml b/qiniu/pom.xml index 214f8906103b5188d77eb72f7e58ef1e599d9164..948c2dc5e08d5335c4da6720b45e17fca320728b 100644 --- a/qiniu/pom.xml +++ b/qiniu/pom.xml @@ -39,6 +39,18 @@ commons-lang3 3.10 + + + io.springfox + springfox-boot-starter + 3.0.0 + + + com.github.xiaoymin + knife4j-spring-boot-starter + 3.0.2 + + diff --git a/qiniu/src/main/java/org/shushuteam/App.java b/qiniu/src/main/java/org/shushuteam/App.java index dfa603a69c984cf46efc95cf5af1179aba4d237f..999e87bff05274e26ae4d2c486fae7bbcfb20edb 100644 --- a/qiniu/src/main/java/org/shushuteam/App.java +++ b/qiniu/src/main/java/org/shushuteam/App.java @@ -5,16 +5,13 @@ import org.springframework.boot.autoconfigure.SpringBootApplication; /** * Hello world! - * */ @SpringBootApplication -public class App -{ - public static void main( String[] args ) - { +public class App { + public static void main(String[] args) { SpringApplication.run(App.class); - System.out.println( "Hello World!" ); + System.out.println("Hello World!"); } } diff --git a/qiniu/src/main/java/org/shushuteam/config/SwaggerConfig.java b/qiniu/src/main/java/org/shushuteam/config/SwaggerConfig.java new file mode 100644 index 0000000000000000000000000000000000000000..862b2bc2d88b2b6fef0d2553bae639d07047f689 --- /dev/null +++ b/qiniu/src/main/java/org/shushuteam/config/SwaggerConfig.java @@ -0,0 +1,41 @@ +package org.shushuteam.config; + +import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j; +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; + +@Configuration +@EnableKnife4j +@EnableOpenApi +public class SwaggerConfig { + + @Bean + public Docket docket() { + return new Docket(DocumentationType.OAS_30) + .groupName("音视频播放平台") + .enable(true) + .apiInfo(apiInfo()).enable(true) + .select() + //添加swagger接口提取范围,修改成指向你的controller包 + .apis(RequestHandlerSelectors.basePackage("org.shushuteam.controller")) + .paths(PathSelectors.any()) + .build(); + } + + private ApiInfo apiInfo() { + return new ApiInfoBuilder() + .title("Knife4j接口文档") + .version("1.0") + .description("这是一个音视频播放平台") + .build(); + } + + +} diff --git a/qiniu/src/main/java/org/shushuteam/controller/TestController.java b/qiniu/src/main/java/org/shushuteam/controller/TestController.java index 10128c9911ede67eee46be0d91870c071ea5372c..c8ff3c60ff1bdab8139648f9e662216cf79fa398 100644 --- a/qiniu/src/main/java/org/shushuteam/controller/TestController.java +++ b/qiniu/src/main/java/org/shushuteam/controller/TestController.java @@ -1,18 +1,28 @@ package org.shushuteam.controller; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RestController; import java.util.Date; -@RestController() +@RestController +@Api(value = "测试", tags = "测试") public class TestController { @GetMapping("test") - public String test(){ - return "你好呀!现在时间是:"+String.valueOf(new Date().toString()); + @ApiOperation(value = "这是一个测试") + public String test(int id, String msg) { + return "你好呀!现在时间是:" + String.valueOf(new Date().toString()); + } + + @PostMapping("test") + @ApiOperation(value = "这是第二个测试") + public String test(String msg) { + return "你好呀!现在时间是:" + String.valueOf(new Date().toString()); } } diff --git a/qiniu/src/main/resources/application.yml b/qiniu/src/main/resources/application.yml index be88d3762f7789d8e7614a33aaa9751f16320704..7ed6001b4069ba2123691ddfc09f90b1f9711caa 100644 --- a/qiniu/src/main/resources/application.yml +++ b/qiniu/src/main/resources/application.yml @@ -1,2 +1,7 @@ server: - port: 8085 \ No newline at end of file + port: 8085 + +spring: + mvc: + pathmatch: + matching-strategy: ant_path_matcher #解决spring 2.7与swagger3不兼容问题