1. 引言
本文档旨在详细描述水电装修项目的接口需求，包括接口的基本功能、参数、返回值等。通过本文档，开发人员可以更好地理解接口的使用方法和注意事项。
2. 接口概述
2.1 接口目的
水电装修接口的主要目的是为了实现水电装修项目的在线管理，包括水电材料采购、施工进度跟踪、验收等环节。
2.2 接口类型
- API接口：用于前后端数据交互，提供数据查询、修改、删除等功能。
- Websocket接口：用于实时推送施工进度、验收结果等信息。
3. 接口列表
3.1 材料采购接口
3.1.1 接口名称
/getMaterials
3.1.2 请求方法
GET
3.1.3 请求参数
- projectId：项目ID，必填。
- page：当前页码，默认为1。
- pageSize：每页显示数量，默认为10。
3.1.4 返回参数
- code：返回码，0表示成功，其他表示失败。
- message：返回信息。
- data：数据列表，包含以下字段：
- id：材料ID。
- name：材料名称。
- price：材料单价。
- quantity：采购数量。
- totalPrice：总价。
3.1.5 示例
{
"code": 0,
"message": "成功",
"data": [
{
"id": 1,
"name": "水管",
"price": 10.0,
"quantity": 100,
"totalPrice": 1000.0
},
{
"id": 2,
"name": "电线",
"price": 5.0,
"quantity": 200,
"totalPrice": 1000.0
}
]
}
3.2 施工进度接口
3.2.1 接口名称
/getProgress
3.2.2 请求方法
GET
3.2.3 请求参数
- projectId：项目ID，必填。
3.2.4 返回参数
- code：返回码，0表示成功，其他表示失败。
- message：返回信息。
- data：施工进度信息，包含以下字段：
- step：施工步骤。
- startTime：开始时间。
- endTime：结束时间。
- status：施工状态（1：进行中，2：已完成）。
3.2.5 示例
{
"code": 0,
"message": "成功",
"data": [
{
"step": "水电改造",
"startTime": "2021-08-01",
"endTime": "2021-08-10",
"status": 1
},
{
"step": "装修",
"startTime": "2021-08-11",
"endTime": "2021-09-01",
"status": 1
}
]
}
3.3 验收接口
3.3.1 接口名称
/accept
3.3.2 请求方法
POST
3.3.3 请求参数
- projectId：项目ID，必填。
- acceptResult：验收结果（1：合格，2：不合格），必填。
3.3.4 返回参数
- code：返回码，0表示成功，其他表示失败。
- message：返回信息。
3.3.5 示例
{
"code": 0,
"message": "验收成功"
}
4. 注意事项
- 所有接口均需在请求头中携带Token进行身份验证。
- Token由后台生成，具体生成方法请咨询相关技术人员。
- 接口返回的数据格式均为JSON格式。
5. 结语
本文档详细描述了水电装修项目的接口需求，旨在为开发人员提供参考。如有任何疑问，请及时与相关人员沟通。