sx/map
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

更新api文档

Browse Source
This commit is contained in:
houwei 2024-07-01 09:08:03 +08:00
parent f6ca0fa72f
commit 7a2c2b5938
1 changed files with 1 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/api/api_list.md
View File

@ -1,24 +1,3 @@
# 概述
## 接口约定
系统中的所有接口均遵循以下约定。
1. 除了与文件上传/下载相关的接口外，都是`POST`请求，请求报文使用`JSON`格式。
2. 文件下载使用GET请求(此种类型，加解密再讨论下)。
3. 文件上传使用POST请求，请求报文使用`multipart/form-data`格式。
## 加密/解密
请求报文，Header中需要添加参数
| 参数名称 | 说明 | 备注 |
| -------- | -------- | --- |
| token | 令牌 | 需要鉴权的API 才需要添加此参数 |
| V | 加密向量 | 必须添加 |
加密采用AES/CBC/ZeroPadding加密方式，密钥长度为16位。，IV长度为16位（每次请求时随机生成）。
# 权限模块
# API接口一览表
@ -593,7 +572,7 @@ sysUser描述
| children | List | YES | 子菜单列表 |
[//]: # (!> 下面的文档有待确认)
[//]: # "!> 下面的文档有待确认"
# 3、公司机构