feat: 更新 API 响应结构,统一使用 statusCode 和 errMsg 替代 code 和 msg;新增用户类型和公司 ID 字段;优化数据库索引;添加公司所有者同步测试脚本
This commit is contained in:
32
docs/api.md
32
docs/api.md
@@ -8,7 +8,7 @@
|
||||
- 基础路径(生产):`https://bai-api.blv-oa.com/pb/api`
|
||||
- 基础路径(本地):`http://localhost:8090/pb/api`
|
||||
- 响应格式:JSON
|
||||
- 业务响应结构统一为:`code`、`msg`、`data`
|
||||
- 业务响应结构统一为:`statusCode`、`errMsg`、`data`
|
||||
- 当前公开接口统一使用 **POST** 方法
|
||||
- 微信写接口统一要求 `Content-Type: application/json`
|
||||
|
||||
@@ -20,8 +20,8 @@
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "操作成功",
|
||||
"statusCode": 200,
|
||||
"errMsg": "操作成功",
|
||||
"data": {}
|
||||
}
|
||||
```
|
||||
@@ -30,8 +30,8 @@
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 400,
|
||||
"msg": "错误信息",
|
||||
"statusCode": 400,
|
||||
"errMsg": "错误信息",
|
||||
"data": {}
|
||||
}
|
||||
```
|
||||
@@ -51,8 +51,8 @@
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "请求成功",
|
||||
"statusCode": 200,
|
||||
"errMsg": "请求成功",
|
||||
"data": {
|
||||
"message": "Hello, World!",
|
||||
"timestamp": "2026-03-20T00:00:00.000Z",
|
||||
@@ -72,8 +72,8 @@
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "服务运行正常",
|
||||
"statusCode": 200,
|
||||
"errMsg": "服务运行正常",
|
||||
"data": {
|
||||
"status": "healthy",
|
||||
"timestamp": "2026-03-20T00:00:00.000Z"
|
||||
@@ -122,8 +122,8 @@
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "登录成功",
|
||||
"statusCode": 200,
|
||||
"errMsg": "登录成功",
|
||||
"data": {
|
||||
"status": "login_success",
|
||||
"is_info_complete": true,
|
||||
@@ -203,8 +203,8 @@
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "信息更新成功",
|
||||
"statusCode": 200,
|
||||
"errMsg": "信息更新成功",
|
||||
"data": {
|
||||
"status": "update_success",
|
||||
"user": {
|
||||
@@ -258,8 +258,8 @@
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "刷新成功",
|
||||
"statusCode": 200,
|
||||
"errMsg": "刷新成功",
|
||||
"data": {
|
||||
"token": "new-jwt-token"
|
||||
}
|
||||
@@ -305,3 +305,5 @@ Authorization: Bearer <token>
|
||||
```
|
||||
|
||||
不需要旧 `Authorization`。
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user