feat(api): standardize REST contracts and auth

This commit is contained in:
2026-07-30 20:38:51 +08:00
parent ae1a657554
commit ba947b616b
86 changed files with 54193 additions and 990 deletions
+24 -24
View File
@@ -15,7 +15,7 @@ from app.services.tjnetwork import (
router = APIRouter()
@router.get(
"/getvalveschema",
"/network-schemas/valve",
summary="获取阀门架构",
description="获取指定水网中所有阀门的架构和字段定义",
)
@@ -30,7 +30,7 @@ async def fastapi_get_valve_schema(
return get_valve_schema(network)
@router.post(
"/addvalve/",
"/valves",
response_model=None,
summary="添加阀门",
description="在指定的水网中添加新的阀门",
@@ -62,8 +62,8 @@ async def fastapi_add_valve(
return add_valve(network, ChangeSet(ps))
@router.post(
"/deletevalve/",
@router.delete(
"/valves",
response_model=None,
summary="删除阀门",
description="从指定的水网中删除指定的阀门",
@@ -81,7 +81,7 @@ async def fastapi_delete_valve(
return delete_valve(network, ChangeSet(ps))
@router.get(
"/getvalvenode1/",
"/valves/node1",
summary="获取阀门起点节点",
description="获取指定阀门连接的起点节点ID",
)
@@ -98,7 +98,7 @@ async def fastapi_get_valve_node1(
return ps["node1"]
@router.get(
"/getvalvenode2/",
"/valves/node2",
summary="获取阀门终点节点",
description="获取指定阀门连接的终点节点ID",
)
@@ -115,7 +115,7 @@ async def fastapi_get_valve_node2(
return ps["node2"]
@router.get(
"/getvalvediameter/",
"/valves/diameter",
summary="获取阀门直径",
description="获取指定阀门的直径",
)
@@ -132,7 +132,7 @@ async def fastapi_get_valve_diameter(
return ps["diameter"]
@router.get(
"/getvalvetype/",
"/valves/type",
summary="获取阀门类型",
description="获取指定阀门的类型",
)
@@ -149,7 +149,7 @@ async def fastapi_get_valve_type(
return ps["type"]
@router.get(
"/getvalvesetting/",
"/valves/setting",
summary="获取阀门开度",
description="获取指定阀门的开度/设置值",
)
@@ -166,7 +166,7 @@ async def fastapi_get_valve_setting(
return ps["setting"]
@router.get(
"/getvalveminorloss/",
"/valves/minor-loss",
summary="获取阀门损失系数",
description="获取指定阀门的损失系数",
)
@@ -182,8 +182,8 @@ async def fastapi_get_valve_minor_loss(
ps = get_valve(network, valve)
return ps["minor_loss"]
@router.post(
"/setvalvenode1/",
@router.patch(
"/valves/node1",
response_model=None,
summary="设置阀门起点节点",
description="设置指定阀门的起点节点",
@@ -201,8 +201,8 @@ async def fastapi_set_valve_node1(
ps = {"id": valve, "node1": node1}
return set_valve(network, ChangeSet(ps))
@router.post(
"/setvalvenode2/",
@router.patch(
"/valves/node2",
response_model=None,
summary="设置阀门终点节点",
description="设置指定阀门的终点节点",
@@ -220,8 +220,8 @@ async def fastapi_set_valve_node2(
ps = {"id": valve, "node2": node2}
return set_valve(network, ChangeSet(ps))
@router.post(
"/setvalvenodediameter/",
@router.patch(
"/valves/diameter",
response_model=None,
summary="设置阀门直径",
description="设置指定阀门的直径",
@@ -239,8 +239,8 @@ async def fastapi_set_valve_diameter(
ps = {"id": valve, "diameter": diameter}
return set_valve(network, ChangeSet(ps))
@router.post(
"/setvalvetype/",
@router.patch(
"/valves/type",
response_model=None,
summary="设置阀门类型",
description="设置指定阀门的类型",
@@ -258,8 +258,8 @@ async def fastapi_set_valve_type(
ps = {"id": valve, "type": type}
return set_valve(network, ChangeSet(ps))
@router.post(
"/setvalvesetting/",
@router.patch(
"/valves/setting",
response_model=None,
summary="设置阀门开度",
description="设置指定阀门的开度/设置值",
@@ -278,7 +278,7 @@ async def fastapi_set_valve_setting(
return set_valve(network, ChangeSet(ps))
@router.get(
"/getvalveproperties/",
"/valves/properties",
summary="获取阀门所有属性",
description="获取指定阀门的所有属性",
)
@@ -294,7 +294,7 @@ async def fastapi_get_valve_properties(
return get_valve(network, valve)
@router.get(
"/getallvalveproperties/",
"/valves",
summary="获取所有阀门属性",
description="获取指定水网中所有阀门的属性",
)
@@ -311,8 +311,8 @@ async def fastapi_get_all_valve_properties(
results = get_all_valves(network)
return results
@router.post(
"/setvalveproperties/",
@router.patch(
"/valves/properties",
response_model=None,
summary="批量设置阀门属性",
description="批量设置指定阀门的多个属性",