feat(api): 实现三端统一的JSON API响应契约

- 新增`api_response.py`统一响应封装工具类,提供标准成功/错误响应构造方法
- 重构WonderQ-Admin全局异常处理器,将所有异常转换为标准响应格式
- 修改所有公共和管理端接口的返回逻辑,统一使用`code`(与HTTP状态码一致)、`msg`和`data`的三层结构
- 新增`api-response-contract.md`文档,定义完整的三端统一JSON响应规范
- 更新所有领域API文档,明确业务数据需位于`data`字段内,补充响应格式说明
- 为WonderQ-MiniAPP和WonderQ-Admin-UI新增响应解析逻辑和类型定义,自动完成协议校验和错误处理
- 更新所有测试用例,适配新的响应结构确保接口符合契约要求
- 新增`module-config-api.md`模块配置API文档,补充站点模块配置的接口约定
- 更新项目README文档,调整文档分类顺序将响应契约置于首位
This commit is contained in:
duanshuwen
2026-08-19 22:02:20 +08:00
parent d16924584c
commit e082bd2d98
28 changed files with 993 additions and 383 deletions

View File

@@ -0,0 +1,41 @@
import { describe, expect, it } from "vitest";
import { ApiProtocolError, ApiRequestError, parseApiResponse } from "@/lib/api";
describe("unified API response parser", () => {
it("returns data from a valid success envelope", () => {
expect(
parseApiResponse<{ items: string[] }>(
{ code: 200, msg: "success", data: { items: ["one"] } },
200,
),
).toEqual({ items: ["one"] });
});
it("exposes structured fields from an API error envelope", () => {
try {
parseApiResponse(
{
code: 404,
msg: "详情不存在",
data: null,
errorCode: "DETAIL_NOT_FOUND",
details: { key: "missing" },
},
404,
);
throw new Error("expected API error");
} catch (error) {
expect(error).toBeInstanceOf(ApiRequestError);
expect((error as ApiRequestError).message).toBe("详情不存在");
expect((error as ApiRequestError).errorCode).toBe("DETAIL_NOT_FOUND");
expect((error as ApiRequestError).details).toEqual({ key: "missing" });
}
});
it("rejects a malformed or mismatched envelope", () => {
expect(() => parseApiResponse({ code: 200, msg: "success" }, 200)).toThrow(ApiProtocolError);
expect(() => parseApiResponse({ code: 201, msg: "success", data: {} }, 200)).toThrow(ApiProtocolError);
expect(() => parseApiResponse({ code: 200, msg: "ok", data: {} }, 200)).toThrow(ApiProtocolError);
});
});