后端的user微服务提供与用户信息相关的、具有类似 CRUD 操作的多个服务。因为与用户相关的信息可被管理员身份和用户身份的用户查看,所以需对API进行分类,分为管理员权限的API,用户权限API和公开的API。每个服务都封装在自己的控制器中,控制器使用业务逻辑类来处理核心功能。以下是结构的快速概述:
- 控制器:处理 HTTP 请求并将其映射到业务逻辑。
- 业务逻辑类:包含用于处理数据的核心逻辑。
- 请求类:定义传入数据的结构。
- 响应类:定义传出数据的结构。
以下是登陆用户权限的API文档:
1. 站内信用户记录表API
-
GET /user/auth/msg/user/list
- Description:学员站内信分页列表接口
- Request Body:AuthMsgUserPageReq
- Response Body:Result<Page<AuthMsgUserResp>>
-
POST /user/auth/msg/user/read
- Description:用户查看站内信
- Request Body:AuthMsgUserGetReq
- Response Body:Result<AuthMsgResp>
2. 订单信息表API
-
POST
/user/auth/order/info/page
- Description:根据条件分页列出订单信息
- Request Body:
AuthOrderInfoReq
- Response Body:
Result<Page<AuthOrderInfoResp>>
-
GET
/user/auth/order/info/view
- Description:获取订单信息
- Request Parameter:
Long orderNo
- Response Body:
Result<AuthOrderInfoResp>
3. 订单支付API
-
POST
/user/auth/order/pay/create
- Description:课程下单接口
- Request Body:
AuthOrderPayReq
- Response Body:
Result<AuthOrderPayResp>
-
POST
/user/auth/order/pay/continue
- Description:课程继续下单接口
- Request Body:
AuthOrderCountinuePayReq
- Response Body:
Result<AuthOrderPayResp>
-
PUT
/user/auth/order/pay/cancel
- Description:取消订单支付
- Request Body:
AuthOrderCancelReq
- Response Body:
Result<String>
4.
用户信息
-
GET
/user/auth/users/view
- Description:获取当前用户的基本信息
- Request Parameters: None
- Response Body:
Result<AuthUsersResp>
-
POST
/user/auth/users/edit
- Description:更新当前用户的基本信息
- Request Body:
AuthUsersReq
- Response Body:
Result<String>