修改问题

2026-07-11 11:03:45 +08:00
parent edc0a58a54
commit db397a7917
38 changed files with 1082 additions and 7994 deletions
@@ -3,27 +3,26 @@ info:
  title: Genealogy PC/H5 API
  version: 1.0.0
  description: |
-    家谱业务 APP/PC 用户侧接口文档，用于 Apifox 导入。
+    家谱业务 PC/H5 用户侧接口文档，用于 Apifox 导入。

    导入方式：Apifox -> 导入 API 数据 -> OpenAPI/Swagger -> 选择本文件。

    约定：
-    - APP 路径前缀为 `/genealogy/app`
    - PC/H5 路径前缀为 `/genealogy/pc`
    - 后台管理接口不包含在本文件内
    - 登录后接口需要携带 token，且请求 Header 需携带 `clientid`
 servers:
-  - url: http://127.0.0.1:8080
+  - url: http://182.61.18.23:8080
    description: Local Java backend
-  - url: http://127.0.0.1:9527/dev-api
+  - url: http://182.61.18.23:8080/dev-api
    description: Local frontend proxy
 tags:
  - name: 验证中心
    description: 统一验证码、天爱行为验证码和系统图形验证码
  - name: 认证登录
-    description: APP/PC 登录注册与账号资料
+    description: PC/H5 登录注册与账号资料
  - name: 文件上传
-    description: APP/PC 统一文件上传与业务引用绑定
+    description: PC/H5 统一文件上传与业务引用绑定
  - name: 行政区划
    description: 行政区划
  - name: 家谱
@@ -67,18 +66,18 @@ paths:
            type: string
          example: "000000"
        - name: clientId
-          description: 客户端ID，对应后台客户端管理中的APP/PC/小程序等终端
+          description: 客户端ID，对应后台 PC/H5 客户端配置
          in: query
          schema:
            type: string
          example: 428a8310cd442757ae699df5d894f051
        - name: sceneCode
-          description: 验证场景编码，例如APP_LOGIN、PC_LOGIN、APP_REGISTER
+          description: 验证场景编码，例如WEB_H5_LOGIN、WEB_H5_REGISTER
          in: query
          required: true
          schema:
            type: string
-          example: APP_LOGIN
+          example: WEB_H5_LOGIN
        - name: subject
          description: 验证主体，通常为手机号、用户ID或登录账号
          in: query
@@ -114,7 +113,7 @@ paths:
    get:
      tags: [验证中心]
      summary: 兼容旧系统图形验证码
-      description: 老版后台登录图形验证码入口。新的 APP/PC 业务优先使用 /captcha/require + /captcha/challenge + /captcha/verify。
+      description: 老版后台登录图形验证码入口。新的 PC/H5 业务优先使用 /captcha/require + /captcha/challenge + /captcha/verify。
      security: []
      responses:
        '200':
@@ -385,7 +384,7 @@ components:
  parameters:
    ClientIdHeader:
      name: clientid
-      description: 客户端ID，请求Header携带，用于区分APP/PC/小程序等终端
+      description: 客户端ID，请求 Header 携带，用于识别 PC/H5 终端
      in: header
      required: true
      schema:
@@ -493,7 +492,7 @@ components:
            phone: "13800000000"
            password: "e10adc3949ba59abbe56e057f20f883e"
            nickName: "测试用户"
-            registerSource: "app"
+            registerSource: "PC"
            validToken: "captcha-ticket-or-sms-token"
    PasswordLogin:
      required: true
@@ -528,7 +527,7 @@ components:
          example:
            tenantId: "000000"
            phone: "13800000000"
-            sceneCode: "APP_LOGIN"
+            sceneCode: "WEB_H5_LOGIN"
            validToken: "captcha-ticket"
    ProfileUpdate:
      required: true
@@ -711,7 +710,7 @@ components:
          example:
            tenantId: "000000"
            clientId: "428a8310cd442757ae699df5d894f051"
-            sceneCode: "APP_LOGIN"
+            sceneCode: "WEB_H5_LOGIN"
            subject: "13800000000"
    VerificationCheck:
      required: true
@@ -725,7 +724,7 @@ components:
              value:
                tenantId: "000000"
                clientId: "428a8310cd442757ae699df5d894f051"
-                sceneCode: "APP_LOGIN"
+                sceneCode: "WEB_H5_LOGIN"
                subject: "13800000000"
                challengeId: "CAPTCHA_CHALLENGE_ID"
                providerCode: "tianai"
@@ -743,7 +742,7 @@ components:
              value:
                tenantId: "000000"
                clientId: "428a8310cd442757ae699df5d894f051"
-                sceneCode: "APP_LOGIN"
+                sceneCode: "WEB_H5_LOGIN"
                subject: "13800000000"
                challengeId: "CAPTCHA_CHALLENGE_ID"
                providerCode: "ruoyi_image"
@@ -923,7 +922,7 @@ components:
          description: 租户ID，用于区分不同租户的数据和验证策略
          type: string
        clientId:
-          description: 客户端ID，对应后台客户端管理中的APP/PC/小程序等终端
+          description: 客户端ID，对应后台 PC/H5 客户端配置
          type: string
        clientKey:
          type: string
@@ -949,7 +948,7 @@ components:
      required: [grantType, tenantId, phone, password]
      properties:
        clientId:
-          description: 客户端ID，对应后台客户端管理中的APP/PC/小程序等终端
+          description: 客户端ID，对应后台 PC/H5 客户端配置
          type: string
        grantType:
          description: 授权类型，例如password、sms、wechat、apple
@@ -971,7 +970,7 @@ components:
          description: 用户昵称
          type: string
        registerSource:
-          description: 注册来源，例如APP、PC、H5、MINI_PROGRAM
+          description: 注册来源，例如PC、H5
          type: string
        validToken:
          description: 验证中心通过后返回的票据，用于注册/登录/换绑等二次校验
@@ -981,7 +980,7 @@ components:
      required: [grantType, tenantId, phone, password]
      properties:
        clientId:
-          description: 客户端ID，对应后台客户端管理中的APP/PC/小程序等终端
+          description: 客户端ID，对应后台 PC/H5 客户端配置
          type: string
        grantType:
          description: 授权类型，例如password、sms、wechat、apple
@@ -1007,7 +1006,7 @@ components:
      required: [grantType, tenantId, phone, smsCode]
      properties:
        clientId:
-          description: 客户端ID，对应后台客户端管理中的APP/PC/小程序等终端
+          description: 客户端ID，对应后台 PC/H5 客户端配置
          type: string
        grantType:
          description: 授权类型，例如password、sms、wechat、apple
@@ -1030,7 +1029,7 @@ components:
      required: [grantType, tenantId, sceneCode, phone, validToken]
      properties:
        clientId:
-          description: 客户端ID，对应后台客户端管理中的APP/PC/小程序等终端
+          description: 客户端ID，对应后台 PC/H5 客户端配置
          type: string
        grantType:
          description: 授权类型，例如password、sms、wechat、apple
@@ -1041,9 +1040,9 @@ components:
          type: string
          example: "000000"
        sceneCode:
-          description: 验证场景编码，例如APP_LOGIN、PC_LOGIN、APP_REGISTER
+          description: 验证场景编码，例如WEB_H5_LOGIN、WEB_H5_REGISTER
          type: string
-          example: APP_LOGIN
+          example: WEB_H5_LOGIN
        phone:
          description: 手机号
          type: string
@@ -1290,14 +1289,14 @@ components:
          description: 客户端 ID
        sceneCode:
          type: string
-          description: 验证场景编码，如 ADMIN_LOGIN/APP_LOGIN/APP_REGISTER
+          description: 验证场景编码，例如WEB_H5_LOGIN、WEB_H5_REGISTER
        subject:
          type: string
          description: 验证主体，如手机号/用户名/IP
      example:
        tenantId: "000000"
        clientId: "428a8310cd442757ae699df5d894f051"
-        sceneCode: "APP_LOGIN"
+        sceneCode: "WEB_H5_LOGIN"
        subject: "13800000000"
    VerificationCheckBody:
      type: object
@@ -1307,10 +1306,10 @@ components:
          description: 租户ID，用于区分不同租户的数据和验证策略
          type: string
        clientId:
-          description: 客户端ID，对应后台客户端管理中的APP/PC/小程序等终端
+          description: 客户端ID，对应后台 PC/H5 客户端配置
          type: string
        sceneCode:
-          description: 验证场景编码，例如APP_LOGIN、PC_LOGIN、APP_REGISTER
+          description: 验证场景编码，例如WEB_H5_LOGIN、WEB_H5_REGISTER
          type: string
        subject:
          description: 验证主体，通常为手机号、用户ID或登录账号
@@ -1341,7 +1340,7 @@ components:
          description: 验证码类型，例如SLIDER、ROTATE、CONCAT、WORD_IMAGE_CLICK
          type: string
        sceneCode:
-          description: 验证场景编码，例如APP_LOGIN、PC_LOGIN、APP_REGISTER
+          description: 验证场景编码，例如WEB_H5_LOGIN、WEB_H5_REGISTER
          type: string
        ttlSeconds:
          description: 验证或票据有效秒数
@@ -1350,7 +1349,7 @@ components:
        required: true
        providerCode: "tianai"
        captchaType: "SLIDER"
-        sceneCode: "APP_LOGIN"
+        sceneCode: "WEB_H5_LOGIN"
        ttlSeconds: 300
    VerificationChallengeVo:
      type: object