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:
1 parent
d16924584c
commit
e082bd2d98
28 files changed
+993
-383
No files matched your search
@@ -138,22 +138,26 @@ def test_admin_wanfa_list_returns_nested_categories_and_routes():
|
||||
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {
|
||||
"categories": [
|
||||
{
|
||||
"id": "family-route",
|
||||
"label": "亲子路线",
|
||||
"routes": [
|
||||
{
|
||||
"id": "family-water",
|
||||
"title": "亲子玩水",
|
||||
"subtitle": "贵州·轻松节奏与自然课堂",
|
||||
"image": "https://example.test/family-water.jpg",
|
||||
"routeCount": 4,
|
||||
"demandKeyword": "亲子玩水",
|
||||
}
|
||||
],
|
||||
}
|
||||
]
|
||||
"code": 200,
|
||||
"msg": "success",
|
||||
"data": {
|
||||
"categories": [
|
||||
{
|
||||
"id": "family-route",
|
||||
"label": "亲子路线",
|
||||
"routes": [
|
||||
{
|
||||
"id": "family-water",
|
||||
"title": "亲子玩水",
|
||||
"subtitle": "贵州·轻松节奏与自然课堂",
|
||||
"image": "https://example.test/family-water.jpg",
|
||||
"routeCount": 4,
|
||||
"demandKeyword": "亲子玩水",
|
||||
}
|
||||
],
|
||||
}
|
||||
]
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
@@ -167,7 +171,7 @@ def test_admin_wanfa_create_category_appends_to_the_end():
|
||||
app.dependency_overrides.clear()
|
||||
|
||||
assert response.status_code == 201
|
||||
assert response.json()["label"] == "新玩法"
|
||||
assert response.json()["data"]["label"] == "新玩法"
|
||||
assert fake_db.added[0].label == "新玩法"
|
||||
assert fake_db.added[0].sortOrder == 3
|
||||
assert fake_db.committed
|
||||
@@ -193,7 +197,7 @@ def test_admin_wanfa_create_route_uses_category_sort_order():
|
||||
app.dependency_overrides.clear()
|
||||
|
||||
assert response.status_code == 201
|
||||
assert response.json()["id"] == "wanfaroute-test-id"
|
||||
assert response.json()["data"]["id"] == "wanfaroute-test-id"
|
||||
assert fake_db.added[0].categoryId == "family-route"
|
||||
assert fake_db.added[0].sortOrder == 2
|
||||
|
||||
@@ -209,7 +213,7 @@ def test_admin_wanfa_delete_rejects_non_empty_category():
|
||||
app.dependency_overrides.clear()
|
||||
|
||||
assert response.status_code == 409
|
||||
assert response.json()["code"] == "WANFA_CATEGORY_NOT_EMPTY"
|
||||
assert response.json()["errorCode"] == "WANFA_CATEGORY_NOT_EMPTY"
|
||||
assert not fake_db.deleted
|
||||
assert not fake_db.committed
|
||||
|
||||
@@ -225,7 +229,7 @@ def test_admin_wanfa_delete_rejects_category_linked_to_home_recommendation():
|
||||
app.dependency_overrides.clear()
|
||||
|
||||
assert response.status_code == 409
|
||||
assert response.json()["code"] == "WANFA_CATEGORY_RECOMMENDED"
|
||||
assert response.json()["errorCode"] == "WANFA_CATEGORY_RECOMMENDED"
|
||||
assert not fake_db.deleted
|
||||
assert not fake_db.committed
|
||||
|
||||
@@ -250,8 +254,8 @@ def test_admin_wanfa_route_update_returns_updated_route():
|
||||
app.dependency_overrides.clear()
|
||||
|
||||
assert response.status_code == 200
|
||||
assert response.json()["title"] == "亲子溯溪"
|
||||
assert response.json()["routeCount"] == 5
|
||||
assert response.json()["data"]["title"] == "亲子溯溪"
|
||||
assert response.json()["data"]["routeCount"] == 5
|
||||
assert route.title == "亲子溯溪"
|
||||
assert route.routeCount == 5
|
||||
assert fake_db.committed
|
||||
@@ -276,7 +280,11 @@ def test_admin_wanfa_route_delete_returns_route_id():
|
||||
app.dependency_overrides.clear()
|
||||
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"id": "family-water"}
|
||||
assert response.json() == {
|
||||
"code": 200,
|
||||
"msg": "success",
|
||||
"data": {"id": "family-water"},
|
||||
}
|
||||
assert fake_db.deleted == [route]
|
||||
assert fake_db.committed
|
||||
|
||||
@@ -295,7 +303,7 @@ def test_admin_wanfa_category_reorder_rejects_incomplete_ids():
|
||||
app.dependency_overrides.clear()
|
||||
|
||||
assert response.status_code == 400
|
||||
assert response.json()["code"] == "WANFA_CATEGORY_REORDER_INVALID"
|
||||
assert response.json()["errorCode"] == "WANFA_CATEGORY_REORDER_INVALID"
|
||||
assert not fake_db.committed
|
||||
|
||||
|
||||
@@ -317,6 +325,6 @@ def test_admin_wanfa_route_reorder_reassigns_sort_order():
|
||||
app.dependency_overrides.clear()
|
||||
|
||||
assert response.status_code == 200
|
||||
assert [item["id"] for item in response.json()["items"]] == ["route-2", "route-1"]
|
||||
assert [item["id"] for item in response.json()["data"]["items"]] == ["route-2", "route-1"]
|
||||
assert {route.id: route.sortOrder for route in routes} == {"route-2": 0, "route-1": 1}
|
||||
assert fake_db.committed
|
||||
Reference in new issue
Block a user