增加短信登录

huimv-employment/fe-api/pom.xml

@@ -30,6 +30,10 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-validation</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.github.xiaoymin</groupId>
+            <artifactId>knife4j-openapi3-spring-boot-starter</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>

huimv-employment/fe-api/src/main/java/com/huimv/employment/config/OpenApiConfig.java

@@ -0,0 +1,44 @@
+package com.huimv.employment.config;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import org.springdoc.core.GroupedOpenApi;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * OpenAPI / Knife4j 接口文档配置。
+ * <p>文档入口：{@code http://localhost:8080/doc.html}</p>
+ */
+@Configuration
+public class OpenApiConfig {
+
+    @Bean
+    public OpenAPI openAPI() {
+        return new OpenAPI()
+                .info(new Info()
+                        .title("灵活用工 fe-server API")
+                        .description("灵活用工与用工税筹 — 小程序端及内部接口")
+                        .version("1.0.0")
+                        .contact(new Contact().name("huimv")))
+                .components(new Components().addSecuritySchemes("Authorization",
+                        new SecurityScheme()
+                                .type(SecurityScheme.Type.HTTP)
+                                .scheme("bearer")
+                                .bearerFormat("JWT")
+                                .in(SecurityScheme.In.HEADER)
+                                .name("Authorization")));
+    }
+
+    /** 小程序端 API 分组 */
+    @Bean
+    public GroupedOpenApi mpApi() {
+        return GroupedOpenApi.builder()
+                .group("小程序端")
+                .pathsToMatch("/api/v1/mp/**")
+                .build();
+    }
+}

huimv-employment/fe-api/src/main/java/com/huimv/employment/controller/mp/AuthController.java

@@ -6,6 +6,8 @@ import com.huimv.employment.service.auth.dto.LoginResponse;
 import com.huimv.employment.service.auth.dto.SmsLoginRequest;
 import com.huimv.employment.service.auth.dto.SmsSendRequest;
 import com.huimv.employment.service.auth.dto.SmsSendResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -21,6 +23,7 @@ import org.springframework.web.bind.annotation.RestController;
  */
 @RestController
 @RequestMapping("/api/v1/mp/auth")
+@Tag(name = "认证", description = "短信验证码登录，匿名访问")
 public class AuthController {
 
     private final AuthService authService;
@@ -42,6 +45,7 @@ public class AuthController {
      * @return 是否 Mock 模式、验证码有效期（秒）
      */
     @PostMapping("/sms/send")
+    @Operation(summary = "发送登录验证码")
     public R<SmsSendResponse> sendSmsCode(@Validated @RequestBody SmsSendRequest request) {
         return R.ok(authService.sendLoginCode(request));
     }
@@ -57,6 +61,7 @@ public class AuthController {
      * @return Token、用户 ID、脱敏手机号等
      */
     @PostMapping("/sms/login")
+    @Operation(summary = "短信验证码登录")
     public R<LoginResponse> loginBySms(@Validated @RequestBody SmsLoginRequest request) {
         return R.ok(authService.loginBySms(request));
     }

huimv-employment/fe-api/src/main/java/com/huimv/employment/controller/mp/HealthController.java

@@ -1,5 +1,7 @@
 package com.huimv.employment.controller.mp;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
@@ -12,9 +14,11 @@ import java.util.Map;
  */
 @RestController
 @RequestMapping("/api/v1/mp")
+@Tag(name = "系统", description = "健康检查等")
 public class HealthController {
 
     @GetMapping("/health")
+    @Operation(summary = "健康检查")
     public Map<String, Object> health() {
         Map<String, Object> body = new HashMap<>(4);
         body.put("code", 200);

huimv-employment/fe-api/src/main/resources/application.yml

@@ -11,6 +11,17 @@ logging:
   file:
     path: logs
 
+springdoc:
+  api-docs:
+    enabled: true
+  swagger-ui:
+    enabled: false
+
+knife4j:
+  enable: true
+  setting:
+    language: zh_cn
+
 fe:
   security:
     jwt-secret: 68df79f4d75b6afc89738872b3e41625330b052dcfcf2bc421450df0290a65g0

huimv-employment/fe-api/src/test/resources/application-test.yml

@@ -9,3 +9,9 @@ spring:
 fe:
   sms:
     mock-enabled: true
+
+springdoc:
+  api-docs:
+    enabled: false
+knife4j:
+  enable: false