Bladeren bron

添加swagger

523096025 1 jaar geleden
bovenliggende
commit
62bd551b75

+ 15 - 0
huimv.nongke.secure/huimv.nongke.secure/pom.xml

@@ -22,6 +22,21 @@
     </properties>
 
     <dependencies>
+<!--        <dependency>-->
+<!--            <groupId>io.springfox</groupId>-->
+<!--            <artifactId>springfox-swagger2</artifactId>-->
+<!--            <version>2.10.5</version>-->
+<!--        </dependency>-->
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>2.9.2</version>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>2.9.2</version>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>

+ 3 - 0
huimv.nongke.secure/huimv.nongke.secure/src/main/java/com/huimv/secure/SecureAppllication.java

@@ -9,9 +9,12 @@ import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
 import org.springframework.context.annotation.Bean;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+//import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
 
 @SpringBootApplication
 @MapperScan("com.huimv.secure.mapper")
+@EnableSwagger2
 public class SecureAppllication {
 
     public static void main(String[] args) {

+ 3 - 2
huimv.nongke.secure/huimv.nongke.secure/src/main/java/com/huimv/secure/config/InterceptorConfig.java

@@ -22,7 +22,7 @@ public class InterceptorConfig implements WebMvcConfigurer {
     @Override
     public void addInterceptors(InterceptorRegistry registry) {
         registry.addInterceptor(jwtInterceptor()).
-                excludePathPatterns("/secureApi/admin/my/*","/secureApi/bill-access-door/getDoorData","/secureApi/bill-gate/getGateData")
+                excludePathPatterns("/secureApi/admin/my/*","/secureApi/bill-access-door/getDoorData","/secureApi/bill-gate/getGateData", "/swagger-resources/**")
                 .excludePathPatterns("/secureApi/receive/feed","/secureApi/bill-personnel-admission/printAdmission"
                         ,"/secureApi/bill-personnel-admission/printAdmission"
                         ,"/secureApi/bill-pcr/printPcr"
@@ -71,6 +71,7 @@ public class InterceptorConfig implements WebMvcConfigurer {
                         ,"/secureApi/bill-personnel-admission/jingJiAdmission"
                         ,"/secureApi/bill-personnel-admission/allCount"
                         ,"/secureApi/bill-pcr/pcrList"
-                        ,"/secureApi/bill-goods-inventory/listAll");
+                        ,"/secureApi/bill-goods-inventory/listAll"
+                        );
     }
 }

+ 32 - 0
huimv.nongke.secure/huimv.nongke.secure/src/main/java/com/huimv/secure/config/SwaggerConfig.java

@@ -0,0 +1,32 @@
+package com.huimv.secure.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+@Configuration
+@EnableSwagger2
+public class SwaggerConfig extends WebMvcConfigurerAdapter {
+
+    @Override
+    public void addResourceHandlers(ResourceHandlerRegistry registry) {
+        registry.addResourceHandler("swagger-ui.html")
+                .addResourceLocations("classpath:/META-INF/resources/");
+
+    }
+    @Bean
+    public Docket api() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .select()
+                .apis(RequestHandlerSelectors.basePackage("com.huimv.secure.controller")) // 替换为你的控制器包路径
+                .paths(PathSelectors.any())
+                .build();
+    }
+
+}

+ 10 - 0
huimv.nongke.secure/huimv.nongke.secure/src/main/java/com/huimv/secure/controller/AgeRangesController.java

@@ -1,6 +1,9 @@
 package com.huimv.secure.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.RestController;
@@ -15,6 +18,13 @@ import org.springframework.web.bind.annotation.RestController;
  */
 @RestController
 @RequestMapping("/age-ranges")
+@Api(tags = "测试")
 public class AgeRangesController {
+    @GetMapping("/hello")
+    @ApiOperation("你好")
+    public String sayHello() {
+        return "Hello, World!";
+    }
+
 
 }