Bladeren bron

优化接口协议格式

java110 5 jaren geleden
bovenliggende
commit
2d6cc76c0e
3 gewijzigde bestanden met toevoegingen van 16 en 16 verwijderingen
  1. 10 10
      docs/document/_sidebar.md
  2. 2 2
      docs/document/api/Readme.md
  3. 4 4
      docs/document/api/apiStart.md

+ 10 - 10
docs/document/_sidebar.md

@@ -1,19 +1,19 @@
 
 
 * 1.入门
 * 1.入门
 
 
-  * [1.1快速开始](README.md)
-  * [1.2环境搭建](start/installHc.md)
-  * [1.3视频教程](start/vedio.md)
-  * [1.4功能列表](func/funcation.md)
-  * [1.5常见问题](start/question.md)
+  * [1.1 快速开始](README.md)
+  * [1.2 环境搭建](start/installHc.md)
+  * [1.3 视频教程](start/vedio.md)
+  * [1.4 功能列表](func/funcation.md)
+  * [1.5 常见问题](start/question.md)
 
 
 * 2.接口能力
 * 2.接口能力
 
 
-  * [2.1接口清单](api/Readme.md)
-  * [2.2调用流程](api/apiStart.md)
-  * [2.3小区商户类接口](api/community/index.md)
-  * [2.4资产类接口](api/capital/index.md)
-  * [2.5用户类接口](api/user/index.md)
+  * [2.1 接口清单](api/Readme.md)
+  * [2.2 调用流程](api/apiStart.md)
+  * [2.3 小区商户类接口](api/community/index.md)
+  * [2.4 资产类接口](api/capital/index.md)
+  * [2.5 用户类接口](api/user/index.md)
   * [投诉建议](api/complaint/saveComplaint.md)
   * [投诉建议](api/complaint/saveComplaint.md)
   * [查询投诉建议](api/complaint/listComplaints.md)
   * [查询投诉建议](api/complaint/listComplaints.md)
   * [删除投诉建议](api/complaint/deleteComplaint.md)
   * [删除投诉建议](api/complaint/deleteComplaint.md)

+ 2 - 2
docs/document/api/Readme.md

@@ -1,8 +1,8 @@
-## 说明
+## 2.1.1 说明
 
 
 我们只梳理了比较重要的接口协议,其他如果需要请自行查看代码梳理协议
 我们只梳理了比较重要的接口协议,其他如果需要请自行查看代码梳理协议
 
 
-## 接口清单
+## 2.1.2 接口清单
 
 
 接口名称|调用地址|调用方式|实现方式或类
 接口名称|调用地址|调用方式|实现方式或类
 :-: | :-: | :-: | :-:
 :-: | :-: | :-: | :-:

+ 4 - 4
docs/document/api/apiStart.md

@@ -1,4 +1,4 @@
-## 如何获取应用
+## 2.2.1 如何获取应用
 
 
 #### 1、登录开发者平台
 #### 1、登录开发者平台
 登录HC小区管理系统开发者账户dev(密码请在u_user中自己修改)
 登录HC小区管理系统开发者账户dev(密码请在u_user中自己修改)
@@ -10,7 +10,7 @@
 应用名称请填写实际调用方名称,如果要开启鉴权方式调用,请填写秘钥,秘钥建议用uuid生成随机字母,如果不鉴权为空,
 应用名称请填写实际调用方名称,如果要开启鉴权方式调用,请填写秘钥,秘钥建议用uuid生成随机字母,如果不鉴权为空,
 白名单和黑名单为调用方出口主机IP限制调用IP
 白名单和黑名单为调用方出口主机IP限制调用IP
 
 
-## 如何接口绑定
+## 2.2.2 如何接口绑定
 
 
 #### 应用绑定接口
 #### 应用绑定接口
 
 
@@ -18,7 +18,7 @@
 ![image](../images/api/002.png)
 ![image](../images/api/002.png)
 ![image](../images/api/003.png)
 ![image](../images/api/003.png)
 
 
-## 如何调用接口
+## 2.2.3 如何调用接口
 
 
 #### 调用地址拼接
 #### 调用地址拼接
 
 
@@ -80,7 +80,7 @@ SIGN:aabdncdhdbd878sbdudn898
 
 
 ![image](../images/api/004.png)
 ![image](../images/api/004.png)
 
 
-## 接口签名
+## 2.2.4 接口签名
 
 
 签名参考以下代码
 签名参考以下代码