From 69bad4c70ed47dd71cd9bd8e8acb15c1470ef940 Mon Sep 17 00:00:00 2001
From: houwei <houwei@jsspisoft.com>
Date: Fri, 28 Jun 2024 12:34:27 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0api?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/api/readme.md | 52 ++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 50 insertions(+), 2 deletions(-)

diff --git a/docs/api/readme.md b/docs/api/readme.md
index 84a7a462..d70931bb 100644
--- a/docs/api/readme.md
+++ b/docs/api/readme.md
@@ -1,4 +1,4 @@
-# 概述
+# API接口概述
 
 ## 接口约定
 
@@ -17,4 +17,52 @@
 | token    | 令牌     |   需要鉴权的API 才需要添加此参数  |
 | V        | 加密向量 |  必须添加   |
 
-加密采用AES/CBC/ZeroPadding加密方式，密钥长度为16位。，IV长度为16位（每次请求时随机生成）。
\ No newline at end of file
+加密采用AES/CBC/ZeroPadding加密方式，密钥长度为16位。，IV长度为16位（每次请求时随机生成）。
+
+
+
+## 返回报文格式定义
+
+### 1、统一返回格式
+
+````json
+{
+	"code": 200,
+	"success": true,
+	"msg": "提示信息",
+	"data": null
+}
+````
+
+
+
+### 2、分页查询数据格式
+
+```json
+{
+    "code": 200,
+	"total": 3,
+	"msg": "查询成功",
+	"rows": [{},{},{}]
+}
+```
+
+
+
+# 系统常量定义
+
+## 1、系统权限
+
+| ID   | 编码                         | 名称         |
+| ---- | ---------------------------- | ------------ |
+| 101  | SYS_AUTHORITY_ID_ADMIN       | 系统管理权限 |
+| 102  | SYS_AUTHORITY_ID_DEVICE_MGR  | 设备维护权限 |
+| 103  | SYS_AUTHORITY_ID_DEVICE_VIEW | 设备浏览权限 |
+
+## 2、设备类型
+
+| ID    | 编码                       | 名称   |
+| ----- | -------------------------- | ------ |
+| 10001 | EQUIPMENT_TYPE_WIND_FARM   | 风电场 |
+| 10002 | EQUIPMENT_TYPE_STATION_WTG | 机组   |
+