Ver Fonte

【CHG】修改swagger配置

ZhaoMn há 4 anos atrás
pai
commit
5d752319d5

+ 6 - 0
railway-admin/src/main/java/com/railway/web/controller/system/SysLoginController.java

@@ -9,6 +9,9 @@ import com.railway.common.utils.SecurityUtils;
 import com.railway.framework.web.service.SysLoginService;
 import com.railway.framework.web.service.SysPermissionService;
 import com.railway.system.service.ISysMenuService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.List;
 import java.util.Set;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -21,6 +24,7 @@ import org.springframework.web.bind.annotation.RestController;
  *
  * @author railway
  */
+@Tag(name = "登录验证")
 @RestController
 public class SysLoginController {
 
@@ -42,6 +46,8 @@ public class SysLoginController {
    * @param loginBody 登录信息
    * @return 结果
    */
+  @Operation(summary = "登录方法")
+  @Parameter(description = "用户登录对象")
   @PostMapping("/login")
   public AjaxResult login(@RequestBody LoginBody loginBody) {
     AjaxResult ajax = AjaxResult.success();

+ 3 - 3
railway-admin/src/main/java/com/railway/web/core/config/SwaggerConfig.java

@@ -79,7 +79,7 @@ public class SwaggerConfig {
    * 安全模式,这里指定token通过Authorization头请求头传递
    */
   private List<SecurityScheme> securitySchemes() {
-    List<SecurityScheme> apiKeyList = new ArrayList<SecurityScheme>();
+    List<SecurityScheme> apiKeyList = new ArrayList<>();
     apiKeyList.add(new ApiKey("Authorization", "Authorization", In.HEADER.toValue()));
     return apiKeyList;
   }
@@ -116,9 +116,9 @@ public class SwaggerConfig {
     // 用ApiInfoBuilder进行定制
     return new ApiInfoBuilder()
         // 设置标题
-        .title("标题:若依管理系统_接口文档")
+        .title("标题:接口文档")
         // 描述
-        .description("描述:用于管理集团旗下公司的人员信息,具体包括XXX,XXX模块...")
+        .description("描述:...")
         // 作者信息
         .contact(new Contact(railwayConfig.getName(), null, null))
         // 版本

+ 1 - 1
railway-common/src/main/java/com/railway/common/filter/RepeatableFilter.java

@@ -19,7 +19,7 @@ import org.springframework.http.MediaType;
 public class RepeatableFilter implements Filter {
 
   @Override
-  public void init(FilterConfig filterConfig) throws ServletException {
+  public void init(FilterConfig filterConfig) {
 
   }
 

+ 6 - 5
railway-common/src/main/java/com/railway/common/filter/RepeatedlyRequestWrapper.java

@@ -5,6 +5,7 @@ import java.io.BufferedReader;
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
 import javax.servlet.ReadListener;
 import javax.servlet.ServletInputStream;
 import javax.servlet.ServletResponse;
@@ -26,25 +27,25 @@ public class RepeatedlyRequestWrapper extends HttpServletRequestWrapper {
     request.setCharacterEncoding("UTF-8");
     response.setCharacterEncoding("UTF-8");
 
-    body = HttpHelper.getBodyString(request).getBytes("UTF-8");
+    body = HttpHelper.getBodyString(request).getBytes(StandardCharsets.UTF_8);
   }
 
   @Override
-  public BufferedReader getReader() throws IOException {
+  public BufferedReader getReader() {
     return new BufferedReader(new InputStreamReader(getInputStream()));
   }
 
   @Override
-  public ServletInputStream getInputStream() throws IOException {
+  public ServletInputStream getInputStream() {
     final ByteArrayInputStream bais = new ByteArrayInputStream(body);
     return new ServletInputStream() {
       @Override
-      public int read() throws IOException {
+      public int read() {
         return bais.read();
       }
 
       @Override
-      public int available() throws IOException {
+      public int available() {
         return body.length;
       }