加入swagger文档

zhoutaoo · zhoutaoo · commit e019ba3daeef · 2019-11-08T22:15:30.000+08:00
diff --git a/auth/authentication-server/pom.xml b/auth/authentication-server/pom.xml
@@ -28,6 +28,15 @@
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-security</artifactId>
         </dependency>
+        <!--Swagger2 - RESTful API文档-->
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+        </dependency>
     </dependencies>
 
     <build>
diff --git a/auth/authentication-server/src/main/java/com/springboot/cloud/auth/authentication/rest/AuthenticationController.java b/auth/authentication-server/src/main/java/com/springboot/cloud/auth/authentication/rest/AuthenticationController.java
@@ -2,22 +2,30 @@
 
 import com.springboot.cloud.auth.authentication.service.IAuthenticationService;
 import com.springboot.cloud.common.core.entity.vo.Result;
+import io.swagger.annotations.*;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 import javax.servlet.http.HttpServletRequest;
 
 @RestController
+@Api("auth")
 @Slf4j
 public class AuthenticationController {
+
     @Autowired
     IAuthenticationService authenticationService;
 
-    @RequestMapping(method = RequestMethod.POST, value = "/auth/permission")
+    @ApiOperation(value = "权限验证", notes = "根据用户token，访问的url和method判断用户是否有权限访问")
+    @ApiImplicitParams({
+            @ApiImplicitParam(paramType = "query", name = "url", value = "访问的url", required = true, dataType = "string"),
+            @ApiImplicitParam(paramType = "query", name = "method", value = "访问的method", required = true, dataType = "string")
+    })
+    @ApiResponses(@ApiResponse(code = 200, message = "处理成功", response = Result.class))
+    @PostMapping(value = "/auth/permission")
     public Result decide(@RequestParam String url, @RequestParam String method, HttpServletRequest request) {
         boolean decide = authenticationService.decide(new HttpServletRequestAuthWrapper(request, url, method));
         return Result.success(decide);
diff --git a/pom.xml b/pom.xml
@@ -46,6 +46,17 @@
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
+            <!--Swagger2 - RESTful API文档-->
+            <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>
         </dependencies>
     </dependencyManagement>
 
