From 989bfe897996f97f2c71d92e3268a5bfb0177a51 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=B0=B7=E6=88=90=E4=BC=9F?= <guchengwei@jsspisoft.com>
Date: Fri, 21 Jun 2024 09:21:31 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E6=8E=A5=E5=8F=A3=E7=BA=A6?=
 =?UTF-8?q?=E5=AE=9A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/api/api_list.md | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/docs/api/api_list.md b/docs/api/api_list.md
index 29958eaa..c3692b8d 100644
--- a/docs/api/api_list.md
+++ b/docs/api/api_list.md
@@ -1,13 +1,23 @@
 # 概述
 
+## 接口约定
+
+系统中的所有接口均遵循以下约定。
+
+1. 除了与文件上传/下载相关的接口外，都是`POST`请求，请求报文使用`JSON`格式。
+2. 文件下载使用GET请求(此种类型，加解密再讨论下)。
+3. 文件上传使用POST请求，请求报文使用`multipart/form-data`格式。
+
+## 加密/解密
+
 请求报文，Header中需要添加参数
 
-| 参数名称 | 说明     |     |
+| 参数名称 | 说明     |   备注  |
 | -------- | -------- | --- |
-| Token    | 令牌     |     |
-| V        | 加密向量 |     |
-
+| Token    | 令牌     |   需要鉴权的API 才需要添加此参数  |
+| V        | 加密向量 |  必须添加   |
 
+加密采用AES/CBC/ZeroPadding加密方式，密钥长度为16位。，IV长度为16位（每次请求时随机生成）。
 
 # 登录模块API接口