|
|
@@ -2,7 +2,8 @@
|
|
|
|
|
|
> **仅依据** `../demand/` PRD 与 [数据库设计-V1.0.md](./数据库设计-V1.0.md)(`wssmet_*` 表);**不参照**存量 Controller/路径实现。
|
|
|
> 路由风格参考 `java6/java-ylsw-bw.md`;统一前缀示例:`/api/wm`(以网关为准)。
|
|
|
-> 返回体:**`ResultResponse<T>`**;分页:**`PageQuery`**(`pageNum`/`pageSize`)。
|
|
|
+> 返回体:**`ResultResponse<T>`**;分页:**`PageQuery`**(`pageNum`/`pageSize`)。
|
|
|
+> **模板接口**:各模块须 **全量列出** 下文 §1.1 标准 CRUD/台账模板路径,**不因 PRD 未写或业务暂未实现而省略**(见 `java6` §接口文档生成)。
|
|
|
|
|
|
## 1. 通用约定
|
|
|
|
|
|
@@ -13,12 +14,37 @@
|
|
|
| 详情 | `GET /{resource}/{id}` |
|
|
|
| 新增 | `POST /{resource}/` |
|
|
|
| 修改 | `POST /{resource}/update` |
|
|
|
-| 删除 | `DELETE /{resource}/{id}` |
|
|
|
-| 批量删 | `DELETE /{resource}/deleteByIds?ids=1,2,3` |
|
|
|
+| 删除 | `DELETE /{resource}/deleteByIds?ids=1,2,3`(**禁止** `DELETE /{resource}/{id}`) |
|
|
|
| 导出 | `GET /{resource}/export`(台账类) |
|
|
|
| 附件 | 请求/响应 `FileEntryList`/`FileEntry`;Entity **`@TableField(exist = false)`**,无库列 |
|
|
|
| 逻辑删除 | 查询默认 `deleted=0` |
|
|
|
|
|
|
+## 1.1 标准接口模板(文档须全量列出)
|
|
|
+
|
|
|
+### 标准 CRUD 资源(`manage` 主数据 / 可写业务表)
|
|
|
+
|
|
|
+每个标准 CRUD 资源在模块章节中 **至少** 包含下表全部行(业务扩展接口另行列出):
|
|
|
+
|
|
|
+| 方法 | 路径 | 说明 |
|
|
|
+|------|------|------|
|
|
|
+| GET | `/{resource}/page` | 分页查询 |
|
|
|
+| GET | `/{resource}/list` | 列表查询(与 page 同 Query) |
|
|
|
+| GET | `/{resource}/{id}` | 详情 |
|
|
|
+| POST | `/{resource}/` | 新增 |
|
|
|
+| POST | `/{resource}/update` | 修改 |
|
|
|
+| DELETE | `/{resource}/deleteByIds` | 删除(逗号分隔主键;单条传 `ids=1`) |
|
|
|
+
|
|
|
+### 台账只读资源(`ledger`)
|
|
|
+
|
|
|
+| 方法 | 路径 | 说明 |
|
|
|
+|------|------|------|
|
|
|
+| GET | `/{resource}/page` | 分页 |
|
|
|
+| GET | `/{resource}/list` | 列表(若适用) |
|
|
|
+| GET | `/{resource}/{id}` | 详情(若适用) |
|
|
|
+| GET | `/{resource}/export` | 导出 |
|
|
|
+
|
|
|
+> 台账类 **不提供** `POST`/`update`/`deleteByIds` 时,在模块说明中标注「台账只读」即可,但仍须列出上表只读模板行。
|
|
|
+
|
|
|
## 2. 工单中心(workflow,无本地 CRUD 表)
|
|
|
|
|
|
| 能力 | 说明 |
|
|
|
@@ -31,30 +57,45 @@
|
|
|
|
|
|
## 3. 水表台账 ` /ledger`
|
|
|
|
|
|
-| 资源 | 路径前缀 | 说明 |
|
|
|
-|------|----------|------|
|
|
|
-| 水表查询 | `/ledger/meter` | 分页/详情/生命周期 |
|
|
|
-| 采购台账 | `/ledger/purchase` | 计划+到货汇总 |
|
|
|
-| 检定台账 | `/ledger/verify` | 多检定类型汇总 |
|
|
|
-| 入库台账 | `/ledger/inventoryIn` | 总仓/分仓筛选 |
|
|
|
-| 出库台账 | `/ledger/inventoryOut` | 总仓/分仓筛选 |
|
|
|
-| 安装台账 | `/ledger/install` | |
|
|
|
-| 换表台账 | `/ledger/replace` | |
|
|
|
-| 周检台账 | `/ledger/inspect` | |
|
|
|
-| 轮换台账 | `/ledger/rotate` | |
|
|
|
-| 报废台账 | `/ledger/scrap` | |
|
|
|
+> 下列资源均为 **台账只读**,各资源须全量列出 §1.1「台账只读资源」模板行(`page`/`list`/`export` 等);下表仅列路径前缀,接口明细按模板展开。
|
|
|
+
|
|
|
+| 资源 | 路径前缀 | 模板接口(须全量列出) |
|
|
|
+|------|----------|------------------------|
|
|
|
+| 水表查询 | `/ledger/meter` | `GET /page`、`GET /list`、`GET /{id}`、`GET /export` |
|
|
|
+| 采购台账 | `/ledger/purchase` | `GET /page`、`GET /export` |
|
|
|
+| 检定台账 | `/ledger/verify` | `GET /page`、`GET /export` |
|
|
|
+| 入库台账 | `/ledger/inventoryIn` | `GET /page`、`GET /export` |
|
|
|
+| 出库台账 | `/ledger/inventoryOut` | `GET /page`、`GET /export` |
|
|
|
+| 安装台账 | `/ledger/install` | `GET /page`、`GET /export` |
|
|
|
+| 换表台账 | `/ledger/replace` | `GET /page`、`GET /export` |
|
|
|
+| 周检台账 | `/ledger/inspect` | `GET /page`、`GET /export` |
|
|
|
+| 轮换台账 | `/ledger/rotate` | `GET /page`、`GET /export` |
|
|
|
+| 报废台账 | `/ledger/scrap` | `GET /page`、`GET /export` |
|
|
|
|
|
|
## 4. 采购管理 ` /manage/purchase`
|
|
|
|
|
|
+### 采购申请 `/purchaseApply`(标准 CRUD + 工单)
|
|
|
+
|
|
|
| 方法 | 路径 | 说明 |
|
|
|
|------|------|------|
|
|
|
-| POST | `/purchaseApply/` | 提交采购申请并发起 workflow |
|
|
|
-| GET | `/purchaseApply/page` | 历史记录 |
|
|
|
+| GET | `/purchaseApply/page` | 分页 |
|
|
|
+| GET | `/purchaseApply/list` | 列表 |
|
|
|
| GET | `/purchaseApply/{id}` | 详情(含明细、工单状态) |
|
|
|
-| POST | `/purchasePlan/` | 新建/编辑计划 |
|
|
|
-| GET | `/purchasePlan/page` | 计划列表 |
|
|
|
-| POST | `/purchasePlan/arrive` | 到货登记(含附件) |
|
|
|
+| POST | `/purchaseApply/` | 新增;提交并发起 workflow |
|
|
|
+| POST | `/purchaseApply/update` | 修改 |
|
|
|
+| DELETE | `/purchaseApply/deleteByIds` | 删除 |
|
|
|
+
|
|
|
+### 采购计划 `/purchasePlan`(标准 CRUD + 业务)
|
|
|
+
|
|
|
+| 方法 | 路径 | 说明 |
|
|
|
+|------|------|------|
|
|
|
+| GET | `/purchasePlan/page` | 分页 |
|
|
|
+| GET | `/purchasePlan/list` | 列表 |
|
|
|
| GET | `/purchasePlan/{id}` | 计划详情 |
|
|
|
+| POST | `/purchasePlan/` | 新建/编辑计划 |
|
|
|
+| POST | `/purchasePlan/update` | 修改 |
|
|
|
+| DELETE | `/purchasePlan/deleteByIds` | 删除 |
|
|
|
+| POST | `/purchasePlan/arrive` | 到货登记(含附件,业务扩展) |
|
|
|
|
|
|
## 5. 落地检 ` /manage/verify/landing`
|
|
|
|
|
|
@@ -157,13 +198,62 @@
|
|
|
|
|
|
## 16. 配置 ` /manage/config`
|
|
|
|
|
|
-| 资源 | 路径 | 说明 |
|
|
|
+以下资源均为 **标准 CRUD**,各资源须 **全量列出** §1.1 模板接口(路径前缀见「路径前缀」列)。
|
|
|
+
|
|
|
+### 仓库 `/warehouse`
|
|
|
+
|
|
|
+| 方法 | 路径 | 说明 |
|
|
|
+|------|------|------|
|
|
|
+| GET | `/warehouse/page` | 分页 |
|
|
|
+| GET | `/warehouse/list` | 列表 |
|
|
|
+| GET | `/warehouse/{id}` | 详情 |
|
|
|
+| POST | `/warehouse/` | 新增 |
|
|
|
+| POST | `/warehouse/update` | 修改 |
|
|
|
+| DELETE | `/warehouse/deleteByIds` | 删除 |
|
|
|
+
|
|
|
+### 厂家 `/brand`
|
|
|
+
|
|
|
+| 方法 | 路径 | 说明 |
|
|
|
+|------|------|------|
|
|
|
+| GET | `/brand/page` | 分页 |
|
|
|
+| GET | `/brand/list` | 列表 |
|
|
|
+| GET | `/brand/{id}` | 详情 |
|
|
|
+| POST | `/brand/` | 新增 |
|
|
|
+| POST | `/brand/update` | 修改 |
|
|
|
+| DELETE | `/brand/deleteByIds` | 删除 |
|
|
|
+
|
|
|
+### 型号 `/brandModel`
|
|
|
+
|
|
|
+| 方法 | 路径 | 说明 |
|
|
|
+|------|------|------|
|
|
|
+| GET | `/brandModel/page` | 分页 |
|
|
|
+| GET | `/brandModel/list` | 列表 |
|
|
|
+| GET | `/brandModel/{id}` | 详情 |
|
|
|
+| POST | `/brandModel/` | 新增 |
|
|
|
+| POST | `/brandModel/update` | 修改 |
|
|
|
+| DELETE | `/brandModel/deleteByIds` | 删除 |
|
|
|
+
|
|
|
+### 周期规则 `/cycleRule`
|
|
|
+
|
|
|
+| 方法 | 路径 | 说明 |
|
|
|
+|------|------|------|
|
|
|
+| GET | `/cycleRule/page` | 分页 |
|
|
|
+| GET | `/cycleRule/list` | 列表 |
|
|
|
+| GET | `/cycleRule/{id}` | 详情 |
|
|
|
+| POST | `/cycleRule/` | 新增 |
|
|
|
+| POST | `/cycleRule/update` | 修改 |
|
|
|
+| DELETE | `/cycleRule/deleteByIds` | 删除 |
|
|
|
+
|
|
|
+### 库存预警 `/inventoryAlertRule`
|
|
|
+
|
|
|
+| 方法 | 路径 | 说明 |
|
|
|
|------|------|------|
|
|
|
-| 仓库 | `/warehouse` | CRUD |
|
|
|
-| 厂家 | `/brand` | CRUD |
|
|
|
-| 型号 | `/brandModel` | CRUD |
|
|
|
-| 周期规则 | `/cycleRule` | CRUD |
|
|
|
-| 库存预警 | `/inventoryAlertRule` | 占位,暂不实现 |
|
|
|
+| GET | `/inventoryAlertRule/page` | 分页(占位,暂不实现) |
|
|
|
+| GET | `/inventoryAlertRule/list` | 列表(占位) |
|
|
|
+| GET | `/inventoryAlertRule/{id}` | 详情(占位) |
|
|
|
+| POST | `/inventoryAlertRule/` | 新增(占位) |
|
|
|
+| POST | `/inventoryAlertRule/update` | 修改(占位) |
|
|
|
+| DELETE | `/inventoryAlertRule/deleteByIds` | 删除(占位) |
|
|
|
|
|
|
## 17. 外部集成 ` /api`
|
|
|
|