山东大学软件学院项目实训——V-Track:虚拟现实环境下的远程教育和智能评估系统（11）后端user微服务的API展示三

后端的user微服务提供与用户信息相关的、具有类似 CRUD 操作的多个服务。因为与用户相关的信息可被管理员身份和用户身份的用户查看，所以需对API进行分类，分为管理员权限的API，用户权限API和公开的API。每个服务都封装在自己的控制器中，控制器使用业务逻辑类来处理核心功能。以下是结构的快速概述：

1. 控制器：处理 HTTP 请求并将其映射到业务逻辑。
2. 业务逻辑类：包含用于处理数据的核心逻辑。
3. 请求类：定义传入数据的结构。
4. 响应类：定义传出数据的结构。

以下是公开的API文档：

1. 订单支付信息表API

POST /user/api/order/pay/notify/{payModel}/{payImpl}

• Description:支付回调通知
• Path Variables:
  • payModel: Integer, indicates the payment model.
  • payImpl: String, specifies the payment implementation details.
• Request Parameters:
  • HttpServletRequest request: HTTP request object containing payment notification data.
• Response Body: String

2. 行政区域

• POST /user/api/region/list

  • Description:根据级别获取区域列出信息
  • Request Body: RegionLevelReq
    • userRegionLevelBO: Request body containing region level information.
  • Response Body: Result<List<RegionResp>>
    • List of RegionResp containing region information.

• POST /user/api/region/list/province

  • Description:根据provinceId获取区域列表信息
  • Request Body: RegionProvinceReq
    • userRegionProvinceBO: Request body containing province ID.
  • Response Body: Result<List<RegionResp>>
    • List of RegionResp containing region information.

• POST /user/api/region/list/city

  • Description:根据cityId获取区域列表信息
  • Request Body: RegionCityIdReq
    • userRegionCityIdBO: Request body containing city ID.
  • Response Body: Result<List<RegionResp>>
    • List of RegionResp containing region information.

3. 用户登录注册

• POST /user/api/users/send/code

  • Description:发送手机验证码
  • Request Body: SendCodeReq
    • req: Request body containing information to send verification code.
  • Response Body: Result<String>
    • Result indicating success or failure of sending the verification code.

• POST /user/api/users/register

  • Description:注册成功返回登录信息
  • Request Body: RegisterReq
    • req: Request body containing user registration information.
  • Response Body: Result<UsersLoginResp>
    • Contains user login information (UsersLoginResp) upon successful registration.

• POST /user/api/users/login

  • Description:密码登录
  • Request Body: LoginReq
    • req: Request body containing user login credentials.
  • Response Body: Result<UsersLoginResp>
    • Contains user login information (UsersLoginResp) upon successful login.

• POST /user/api/users/password

  • Description:重置密码
  • Request Body: PasswordReq
    • req: Request body containing user information and new password.
  • Response Body: Result<String>
    • Result indicating success or failure of password reset.