补充技能说明

2026-05-20 14:59:18 +08:00
parent 2dfe06bef7
commit 5835df7263
38 changed files with 618 additions and 83 deletions
@@ -23,3 +23,14 @@ version: 3.0.0
 | POST | `/api/v1/setruleproperties/` | 设置规则属性 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getcontrolschema/` | 返回简单控制（Control）数据模型的字段定义 |
+| `GET /getcontrolproperties/` | 获取管网中所有简单控制规则的属性列表 |
+| `GET /getruleschema/` | 返回规则控制（Rule）数据模型的字段定义 |
+| `GET /getruleproperties/` | 获取管网中所有基于规则的复杂控制条件列表 |
+| `POST /setcontrolproperties/` | 设置/更新简单控制规则的属性 |
+| `POST /setruleproperties/` | 设置/更新规则控制的属性 |
@@ -24,3 +24,14 @@ version: 3.0.0
 | POST | `/api/v1/setcurveproperties/` | 设置曲线属性 | network (query), curve (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getcurveschema` | 返回曲线（Curve）数据模型的字段定义（水泵特性曲线、效率曲线等） |
+| `GET /getcurves/` | 获取管网中所有曲线的ID列表 |
+| `GET /getcurveproperties/` | 查询指定曲线的详细属性（类型、控制点数据等） |
+| `POST /addcurve/` | 向管网添加一条新曲线 |
+| `POST /deletecurve/` | 从管网删除指定曲线 |
+| `POST /setcurveproperties/` | 设置/更新曲线的属性（控制点坐标等） |
@@ -29,3 +29,15 @@ version: 3.0.0
 | POST | `/api/v1/settimeproperties/` | 设置时间选项属性 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getoptionschema/` | 返回模拟选项（Options）数据模型的字段定义 |
+| `GET /getoptionproperties/` | 获取管网模拟参数设置（时步、精度、单位系统等） |
+| `GET /getenergyschema/` | 返回能耗选项（Energy）数据模型的字段定义 |
+| `GET /getenergyproperties/` | 获取全局能耗设置（电价、效率等） |
+| `GET /getpumpenergyproperties/` | 获取单台水泵的能耗参数 |
+| `POST /setoptionproperties/` | 设置管网模拟参数 |
+| `POST /setenergyproperties/` | 设置全局能耗参数 |
@@ -24,3 +24,14 @@ version: 3.0.0
 | POST | `/api/v1/setpatternproperties/` | 设置模式属性 | network (query), pattern (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getpatternschema` | 返回模式（Pattern）数据模型的字段定义 |
+| `GET /getpatterns/` | 获取管网中所有时间模式的ID列表 |
+| `GET /getpatternproperties/` | 查询指定模式的属性（时间序列乘数值等） |
+| `POST /addpattern/` | 向管网添加一个新时间模式 |
+| `POST /deletepattern/` | 从管网删除指定时间模式 |
+| `POST /setpatternproperties/` | 设置/更新时间模式的属性（乘数序列） |
@@ -42,3 +42,18 @@ version: 3.0.0
 | POST | `/api/v1/settankreaction/` | 设置水池反应属性 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getemitterproperties/` | 查询节点处发射器（用于模拟管漏）的属性 |
+| `GET /getmixingproperties/` | 查询水箱水质混合模型属性 |
+| `GET /getsourceproperties/` | 查询水质污染源的属性（位置、类型、浓度等） |
+| `GET /getreactionproperties/` | 获取全局水质反应参数（管网反应系数等） |
+| `GET /getwaterqualityresult/` | 查询水质模拟结果 |
+| `POST /addsource/` | 向管网添加一个水质污染源 |
+| `POST /deletesource/` | 删除指定水质污染源 |
+| `POST /addmixing/` | 为水箱添加水质混合模型 |
+| `POST /deletemixing/` | 删除水箱水质混合模型 |
+| `POST /setemitter*/` | 设置发射器属性（流量系数等） |
@@ -32,3 +32,14 @@ version: 3.0.0
 | POST | `/api/v1/setvertexproperties/` | 设置图形元素属性 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getallvertexlinks/` | 获取所有管线的折点列表（用于地图还原管线真实走向） |
+| `GET /getvertexlink/` | 获取单条管线的折点坐标序列 |
+| `POST /addvertex/` | 为管线添加一个折点（改变管线显示路径） |
+| `POST /deletevertex/` | 删除管线上的指定折点 |
+| `POST /addlabel/` | 在地图上添加文字标注 |
+| `POST /deletelabel/` | 删除地图文字标注 |
@@ -15,10 +15,18 @@ version: 3.0.0
 ## 接口目录
 | Method | Path | Summary | Required Params | Optional Params |
 |---|---|---|---|---|
-| POST | `/api/v1/auth/login` | login | form_data (body) | - |
-| POST | `/api/v1/auth/login/simple` | login_simple | username (query), password (query) | - |
-| GET | `/api/v1/auth/me` | get_current_user_info | - | - |
-| POST | `/api/v1/auth/refresh` | refresh_token | refresh_token (query) | - |
-| POST | `/api/v1/auth/register` | register | user_data (body) | - |
+| POST | `/api/v1/auth/login` | 用户登录 | form_data (body) | - |
+| POST | `/api/v1/auth/login/simple` | 简化版登录 | username (query), password (query) | - |
+| GET | `/api/v1/auth/me` | 获取当前用户信息 | - | - |
+| POST | `/api/v1/auth/refresh` | 刷新AccessToken | refresh_token (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `POST /login` | OAuth2标准格式登录，提交form-data（username+password），返回JWT Access Token和Refresh Token |
+| `POST /login/simple` | 简化版登录，直接通过query参数传递username和password，保持向后兼容 |
+| `GET /me` | 返回当前已登录用户的详细信息（需携带Access Token） |
+| `POST /refresh` | 使用Refresh Token换取新的Access Token，延续会话 |
@@ -23,3 +23,14 @@ version: 3.0.0
 | POST | `/api/v1/users/{user_id}/deactivate` | 停用用户 | user_id (path) | - |

 - 覆盖方法：`DELETE, GET, POST, PUT`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /users/` | 列出系统中所有用户（管理员权限），支持分页（skip/limit） |
+| `GET /users/{user_id}` | 按用户ID查询单个用户的详细信息 |
+| `PUT /users/{user_id}` | 更新指定用户的信息（邮箱、角色、密码等），请求体为 user_update 对象 |
+| `DELETE /users/{user_id}` | 删除指定用户（软删除或硬删除） |
+| `POST /users/{user_id}/activate` | 激活指定用户账号（管理员操作） |
+| `POST /users/{user_id}/deactivate` | 停用指定用户账号（禁止登录，管理员操作） |
@@ -20,3 +20,11 @@ version: 3.0.0
 | GET | `/api/v1/getuserschema/` | 获取用户模式 | network (query) | - |

 - 覆盖方法：`GET`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getallusers/` | 获取指定管网下的所有用户列表（旧版接口，返回管网级别用户信息） |
+| `GET /getuser/` | 按用户名查询指定管网下的单个用户信息 |
+| `GET /getuserschema/` | 获取用户数据模型的字段定义（Schema） |
@@ -23,3 +23,14 @@ version: 3.0.0
 | POST | `/api/v1/setdemandproperties/` | 设置需水量属性 | network (query), junction (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getdemandschema` | 返回需水量（Demand）数据模型的字段定义 |
+| `GET /getdemandproperties/` | 查询指定节点的需水量属性（基础需水量、模式等） |
+| `POST /setdemandproperties/` | 设置节点的需水量属性 |
+| `POST /calculatedemandtonodes/` | 将指定总需水量计算分配到各节点 |
+| `POST /calculatedemandtoregion/` | 将指定总需水量计算分配到指定区域内的节点 |
+| `POST /calculatedemandtonetwork/` | 将指定总需水量按比例分配到整个管网的所有节点 |
@@ -46,3 +46,17 @@ version: 3.0.0
 | GET | `/api/v1/settitle/` | 设置水网标题属性 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getelementtype/` | 查询指定ID元素的类型（Junction/Pipe/Pump/Tank/Valve/Reservoir） |
+| `GET /getelementtypevalue/` | 查询指定ID元素的类型编码值 |
+| `GET /getelementproperties/` | 查询指定ID元素的所有属性（自动识别类型） |
+| `GET /getelementpropertieswithtype/` | 查询指定类型和ID的元素属性 |
+| `GET /getlinkproperties/` | 查询管线（Pipe/Pump/Valve）的属性 |
+| `GET /getnodeproperties/` | 查询节点（Junction/Tank/Reservoir）的属性 |
+| `GET /settitle/` | 设置管网标题属性 |
+| `POST /deletelink/` | 删除管线（管道/水泵/阀门） |
+| `POST /deletenode/` | 删除节点（节点/水箱/水库） |
@@ -23,3 +23,14 @@ version: 3.0.0
 | GET | `/api/v1/getnodecoord/` | 获取节点坐标 | network (query), node (query) | - |

 - 覆盖方法：`GET`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getnodecoord/` | 查询单个节点（任意类型）的坐标（x, y） |
+| `GET /getmajornodecoords/` | 获取管网主要节点（干管节点）的坐标列表，用于快速渲染 |
+| `GET /getmajorpipenodes/` | 获取主要管道的起终节点列表 |
+| `GET /getnetworklinknodes/` | 获取管网中所有管线的起终节点信息 |
+| `GET /getnetworkgeometries/` | 获取整个管网的完整几何信息（节点坐标 + 管线折点），适合地图绘制 |
+| `GET /getnetworkinextent/` | 查询指定地理范围（bbox）内的管网节点和管线 |
@@ -35,3 +35,18 @@ version: 3.0.0
 | POST | `/api/v1/setjunctiony/` | 设置节点 Y 坐标 | network (query), junction (query), y (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getjunctionschema` | 返回节点（Junction）数据模型的所有字段定义 |
+| `GET /getjunctionproperties/` | 查询单个节点的所有属性（标高、需水量、坐标等） |
+| `GET /getalljunctionproperties/` | 批量获取管网中所有节点的属性列表 |
+| `GET /getjunctioncoord/` | 查询单个节点的坐标（x, y） |
+| `GET /getjunctionelevation/` | 查询节点标高值 |
+| `GET /getjunctiondemand/` | 查询节点基础需水量 |
+| `GET /getjunctionpattern/` | 查询节点关联的需水时间模式名称 |
+| `POST /addjunction/` | 向管网添加一个新节点，需提供ID、坐标和标高 |
+| `POST /deletejunction/` | 从管网删除指定节点 |
+| `POST /setjunction*/` | 设置节点某个具体属性（坐标、标高、需水量等） |
@@ -37,3 +37,18 @@ version: 3.0.0
 | POST | `/api/v1/setpipestatus/` | 设置管道状态 | network (query), pipe (query), status (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getpipeschema` | 返回管道（Pipe）数据模型的所有字段定义 |
+| `GET /getpipeproperties/` | 查询单条管道的所有属性（管径、长度、起终节点等） |
+| `GET /getallpipeproperties/` | 批量获取管网中所有管道的属性列表 |
+| `GET /getpipelength/` | 查询管道长度 |
+| `GET /getpipediameter/` | 查询管道管径 |
+| `GET /getpipestatus/` | 查询管道当前状态（开/关/CV） |
+| `GET /getpiperoughness/` | 查询管道粗糙系数 |
+| `POST /addpipe/` | 向管网添加一条新管道，需提供ID、起终节点、长度和管径 |
+| `POST /deletepipe/` | 从管网删除指定管道 |
+| `POST /setpipe*/` | 设置管道某个具体属性（管径、长度、状态等） |
@@ -27,3 +27,16 @@ version: 3.0.0
 | POST | `/api/v1/setpumpproperties/` | 设置水泵属性 | network (query), pump (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getpumpschema` | 返回水泵（Pump）数据模型的所有字段定义 |
+| `GET /getpumpproperties/` | 查询单台水泵的所有属性（曲线名称、起终节点等） |
+| `GET /getallpumpproperties/` | 批量获取管网中所有水泵的属性列表 |
+| `POST /addpump/` | 向管网添加一台新水泵，需提供ID和起终节点 |
+| `POST /deletepump/` | 从管网删除指定水泵 |
+| `POST /setpumpproperties/` | 批量设置水泵属性（曲线、初始状态、效率等） |
+| `POST /setpumpnode1/` | 设置水泵起始节点 |
+| `POST /setpumpnode2/` | 设置水泵终止节点 |
@@ -54,3 +54,20 @@ version: 3.0.0
 | POST | `/api/v1/setvirtualdistrict/` | 设置虚拟分区属性 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getregionschema` | 返回区域（Region）数据模型的字段定义 |
+| `GET /getregion/` | 查询单个区域的属性 |
+| `GET /getallregions/` | 获取管网中所有区域列表 |
+| `GET /getalldistrictmeteringareas/` | 获取所有 DMA（独立计量区）列表 |
+| `GET /getallserviceareas/` | 获取所有服务区列表 |
+| `POST /addregion/` | 新增区域（需提供名称和节点/管道列表） |
+| `POST /adddistrictmeteringarea/` | 新增 DMA 分区 |
+| `POST /addvirtualdistrict/` | 新增虚拟分区 |
+| `POST /addservicearea/` | 新增服务区 |
+| `POST /calculatedistrictmeteringarea/` | 为指定节点集合计算其所属 DMA |
+| `POST /calculatedistrictmeteringareaforregion/` | 为指定区域内的所有节点计算 DMA 归属 |
+| `POST /calculatedistrictmeteringareafornetwork/` | 为整个管网的所有节点计算 DMA 归属 |
@@ -33,3 +33,16 @@ version: 3.0.0
 | POST | `/api/v1/setreservoiry/` | 设置水库Y坐标 | network (query), reservoir (query), y (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getreservoirschema` | 返回水库（Reservoir）数据模型的所有字段定义 |
+| `GET /getreservoirproperties/` | 查询单个水库的所有属性（水头、模式、坐标等） |
+| `GET /getallreservoirproperties/` | 批量获取管网中所有水库的属性列表 |
+| `GET /getreservoirhead/` | 查询水库水头（即水库水位高度） |
+| `GET /getreservoirpattern/` | 查询水库关联的时间模式名称 |
+| `POST /addreservoir/` | 向管网添加一个新水库，需提供ID、坐标和水头 |
+| `POST /deletereservoir/` | 从管网删除指定水库 |
+| `POST /setreservoir*/` | 设置水库某个具体属性（水头、模式、坐标等） |
@@ -21,3 +21,12 @@ version: 3.0.0
 | POST | `/api/v1/settag/` | 设置标签 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /gettagschema/` | 返回标签（Tag）数据模型的字段定义 |
+| `GET /gettag/` | 查询单个元素绑定的标签信息 |
+| `GET /gettags/` | 获取管网中所有标签列表 |
+| `POST /settag/` | 为管网元素设置/更新标签（支持自定义键值对属性） |
@@ -45,3 +45,17 @@ version: 3.0.0
 | POST | `/api/v1/settanky/` | 设置水箱Y坐标 | network (query), tank (query), y (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /gettankschema` | 返回水箱（Tank）数据模型的所有字段定义 |
+| `GET /gettankproperties/` | 查询单个水箱的所有属性（标高、直径、初始/最大/最小水位等） |
+| `GET /getalltankproperties/` | 批量获取管网中所有水箱的属性列表 |
+| `GET /gettankelevation/` | 查询水箱底部标高 |
+| `GET /gettankdiameter/` | 查询水箱直径 |
+| `GET /gettankinitlevel/` | 查询水箱初始水位 |
+| `POST /addtank/` | 向管网添加一个新水箱，需提供ID、坐标、标高和水位参数 |
+| `POST /deletetank/` | 从管网删除指定水箱 |
+| `POST /settank*/` | 设置水箱某个具体属性（坐标、标高、直径、水位等） |
@@ -34,3 +34,17 @@ version: 3.0.0
 | POST | `/api/v1/setvalvetype/` | 设置阀门类型 | network (query), valve (query), type (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getvalveschema` | 返回阀门（Valve）数据模型的所有字段定义 |
+| `GET /getvalveproperties/` | 查询单个阀门的所有属性（管径、类型、设定值等） |
+| `GET /getallvalveproperties/` | 批量获取管网中所有阀门的属性列表 |
+| `GET /getvalvediameter/` | 查询阀门管径 |
+| `GET /getvalvetype/` | 查询阀门类型（PRV/PSV/TCV/FCV/PBV/GPV） |
+| `GET /getvalvesetting/` | 查询阀门设定值（压力设定或流量设定） |
+| `POST /addvalve/` | 向管网添加一个新阀门，需提供ID、起终节点、管径和类型 |
+| `POST /deletevalve/` | 从管网删除指定阀门 |
+| `POST /setvalve*/` | 设置阀门某个具体属性（类型、设定值、管径等） |
@@ -21,3 +21,12 @@ version: 3.0.0
 | POST | `/api/v1/setextensiondata/` | 设置扩展数据 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getallextensiondatakeys/` | 获取当前管网中所有已存储的自定义扩展数据的键名列表 |
+| `GET /getallextensiondata/` | 获取当前管网所有自定义扩展数据（键值对集合） |
+| `GET /getextensiondata/` | 按 key 查询指定的自定义扩展数据值 |
+| `POST /setextensiondata/` | 设置或更新一个自定义扩展数据键值对（可用于存储任意业务自定义信息） |
@@ -23,3 +23,14 @@ version: 3.0.0
 | POST | `/api/v1/test_dict/` | 测试字典处理 | data (body) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getallburstlocateresults/` | 获取当前管网所有历史爆管定位分析结果（旧版接口） |
+| `GET /getallsensorplacements/` | 获取当前管网所有传感器布置方案的结果列表 |
+| `GET /getsimulationresult/` | 获取最近一次水力模拟结果（旧版接口） |
+| `GET /getrealtimedata/` | 获取管网实时监测数据（旧版接口） |
+| `GET /getjson/` | 返回示例 JSON 数据结构，用于开发调试 |
+| `POST /test_dict/` | 测试字典类型请求体的接口，用于开发调试 |
@@ -21,3 +21,12 @@ version: 3.0.0
 | GET | `/api/v1/scheme-list` | 获取方案列表 | - | - |

 - 覆盖方法：`GET`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /burst-locate-result` | 获取所有爆管定位事件的历史结果列表（新版REST接口） |
+| `GET /burst-locate-result/{burst_incident}` | 查询指定爆管事件（burst_incident ID）的详细定位结果 |
+| `GET /scada-info` | 获取当前项目关联的 SCADA 设备和监测点信息汇总 |
+| `GET /scheme-list` | 获取当前项目中所有可用的水力计算方案列表 |
@@ -15,34 +15,41 @@ version: 3.0.0
 ## 接口目录
 | Method | Path | Summary | Required Params | Optional Params |
 |---|---|---|---|---|
-| POST | `/api/v1/closeproject/` | 关闭项目 | network (query) | - |
-| GET | `/api/v1/convertv3tov2/` | 转换 INP V3 为 V2 | - | - |
-| GET | `/api/v1/convertv3tov2/` | 转换 INP V3 为 V2 | - | - |
-| POST | `/api/v1/copyproject/` | 复制项目 | source (query), target (query) | - |
+| GET | `/api/v1/listprojects/` | 获取项目列表 | - | - |
+| GET | `/api/v1/project_info/` | 获取项目信息 | network (query) | - |
+| GET | `/api/v1/haveproject/` | 检查项目是否存在 | network (query) | - |
 | POST | `/api/v1/createproject/` | 创建新项目 | network (query) | - |
 | POST | `/api/v1/deleteproject/` | 删除项目 | network (query) | - |
-| GET | `/api/v1/downloadinp/` | 下载 INP 文件 | name (query) | - |
-| GET | `/api/v1/downloadinp/` | 下载 INP 文件 | name (query) | - |
-| GET | `/api/v1/dumpinp/` | 导出项目到 INP 文件 | network (query), inp (query) | - |
-| GET | `/api/v1/dumpinp/` | 导出项目到 INP 文件 | network (query), inp (query) | - |
-| GET | `/api/v1/exportinp/` | 导出项目为 ChangeSet | network (query), version (query) | - |
-| GET | `/api/v1/haveproject/` | 检查项目是否存在 | network (query) | - |
-| POST | `/api/v1/importinp/` | 导入 INP 文件内容 | network (query) | - |
-| GET | `/api/v1/isprojectlocked/` | 检查项目是否被锁定 | network (query) | - |
-| GET | `/api/v1/isprojectlocked/` | 检查项目是否被锁定 | network (query) | - |
-| GET | `/api/v1/isprojectlockedbyme/` | 检查项目是否被当前用户锁定 | network (query) | - |
-| GET | `/api/v1/isprojectlockedbyme/` | 检查项目是否被当前用户锁定 | network (query) | - |
+| POST | `/api/v1/copyproject/` | 复制项目 | source (query), target (query) | - |
 | GET | `/api/v1/isprojectopen/` | 检查项目是否已打开 | network (query) | - |
-| GET | `/api/v1/listprojects/` | 获取项目列表 | - | - |
-| POST | `/api/v1/lockproject/` | 锁定项目 | network (query) | - |
-| POST | `/api/v1/lockproject/` | 锁定项目 | network (query) | - |
 | POST | `/api/v1/openproject/` | 打开项目 | network (query) | - |
-| GET | `/api/v1/project_info/` | 获取项目信息 | network (query) | - |
-| POST | `/api/v1/readinp/` | 读取 INP 文件到项目 | network (query), inp (query) | - |
-| POST | `/api/v1/readinp/` | 读取 INP 文件到项目 | network (query), inp (query) | - |
-| POST | `/api/v1/unlockproject/` | 解锁项目 | network (query) | - |
+| POST | `/api/v1/closeproject/` | 关闭项目 | network (query) | - |
+| GET | `/api/v1/isprojectlocked/` | 检查项目是否被锁定 | network (query) | - |
+| GET | `/api/v1/isprojectlockedbyme/` | 检查项目是否被当前用户锁定 | network (query) | - |
+| POST | `/api/v1/lockproject/` | 锁定项目 | network (query) | - |
 | POST | `/api/v1/unlockproject/` | 解锁项目 | network (query) | - |
+| POST | `/api/v1/importinp/` | 导入 INP 文件内容 | network (query) | - |
+| GET | `/api/v1/exportinp/` | 导出项目为 ChangeSet | network (query), version (query) | - |
+| POST | `/api/v1/readinp/` | 读取 INP 文件到项目 | network (query), inp (query) | - |
+| GET | `/api/v1/dumpinp/` | 导出项目到 INP 文件 | network (query), inp (query) | - |
 | POST | `/api/v1/uploadinp/` | 上传 INP 文件 | afile (body), name (query) | - |
-| POST | `/api/v1/uploadinp/` | 上传 INP 文件 | afile (body), name (query) | - |
+| GET | `/api/v1/downloadinp/` | 下载 INP 文件 | name (query) | - |
+| GET | `/api/v1/convertv3tov2/` | 转换 INP V3 为 V2 | - | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /listprojects/` | 获取服务器上所有可用的供水管网项目名称列表 |
+| `GET /project_info/` | 从数据库获取项目的详细信息，包括地图范围等配置 |
+| `POST /createproject/` | 创建一个新的供水管网项目；若已存在可能覆盖或报错 |
+| `POST /deleteproject/` | 永久删除指定项目，此操作不可恢复 |
+| `POST /openproject/` | 将指定项目加载到内存并初始化数据库连接池 |
+| `POST /closeproject/` | 将指定项目从内存中卸载，释放相关资源 |
+| `POST /lockproject/` | 锁定项目以防止并发修改 |
+| `POST /unlockproject/` | 释放对项目的锁定 |
+| `POST /importinp/` | 将 INP 格式文本内容导入到指定项目 |
+| `GET /exportinp/` | 导出项目变更集（ChangeSet），含顶点、SCADA元素、DMA、SA、VD等 |
+| `GET /convertv3tov2/` | 将 EPANET 3.0 格式的 INP 内容转换为 2.x 格式 |
@@ -20,3 +20,11 @@ version: 3.0.0
 | GET | `/api/v1/getschemeschema/` | 获取方案模式 | network (query) | - |

 - 覆盖方法：`GET`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getschemeschema/` | 返回方案（Scheme）数据模型的字段定义 |
+| `GET /getallschemes/` | 获取当前管网下所有已保存方案的列表 |
+| `GET /getscheme/` | 查询指定方案名称（schema_name）的详细属性和配置 |
@@ -35,3 +35,20 @@ version: 3.0.0
 | POST | `/api/v1/undo/` | 撤销操作 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getsnapshots/` | 列出当前管网所有已保存的快照标签（tag）列表 |
+| `GET /havesnapshot/` | 检查指定 tag 的快照是否存在 |
+| `POST /takesnapshot/` | 保存当前管网状态为一个快照，tag 为快照名称 |
+| `POST /picksnapshot/` | 将管网状态回滚到指定快照，discard=true 时丢弃当前未保存修改 |
+| `GET /getcurrentoperationid/` | 获取当前管网的操作ID（用于追踪操作历史） |
+| `POST /undo/` | 撤销对管网的最近一次操作 |
+| `POST /redo/` | 重做上一次被撤销的操作 |
+| `POST /batch/` | 批量执行多个管网操作命令（原子事务） |
+| `POST /compressedbatch/` | 执行压缩格式的批量命令（减少网络传输量） |
+| `GET /syncwithserver/` | 将客户端的操作与服务端管网状态同步 |
+| `POST /pickoperation/` | 切换到指定 operation ID 的历史操作状态 |
+| `POST /takesnapshotforcurrentoperation` | 为当前 operation 创建快照（保存当前操作节点状态） |