From 53a0cdd4a175e1f97a4b277222486b109d29055b Mon Sep 17 00:00:00 2001
From: java110 <928255095@qq.com>
Date: 星期六, 13 六月 2020 13:46:20 +0800
Subject: [PATCH] 加入文档
---
docs/document/api/apiStart.md | 126 +++++++++++++++++++++++++++++++++++++++++-
1 files changed, 123 insertions(+), 3 deletions(-)
diff --git a/docs/document/api/apiStart.md b/docs/document/api/apiStart.md
index 95be3d6..9bd6def 100644
--- a/docs/document/api/apiStart.md
+++ b/docs/document/api/apiStart.md
@@ -1,6 +1,126 @@
## 濡備綍鑾峰彇搴旂敤
-1銆佺櫥褰旽C灏忓尯绠＄悊绯荤粺寮�鍙戣�呰处鎴穌ev(瀵嗙爜璇峰湪u_user涓嚜宸变慨鏀�)
+#### 1銆佺櫥褰曞紑鍙戣�呭钩鍙�
+鐧诲綍HC灏忓尯绠＄悊绯荤粺寮�鍙戣�呰处鎴穌ev(瀵嗙爜璇峰湪u_user涓嚜宸变慨鏀�)
-2銆佸湪鏈嶅姟绠＄悊> 搴旂敤淇℃伅 涓坊鍔犲簲鐢� 濡備笅鍥�
-
\ No newline at end of file
+#### 2銆佹坊鍔犲簲鐢�
+鍦ㄦ湇鍔＄鐞�> 搴旂敤淇℃伅 涓坊鍔犲簲鐢� 濡備笅鍥�
+
+
+搴旂敤鍚嶇О璇峰～鍐欏疄闄呰皟鐢ㄦ柟鍚嶇О锛屽鏋滆寮�鍚壌鏉冩柟寮忚皟鐢紝璇峰～鍐欑閽ワ紝绉橀挜寤鸿鐢╱uid鐢熸垚闅忔満瀛楁瘝锛屽鏋滀笉閴存潈涓虹┖锛�
+鐧藉悕鍗曞拰榛戝悕鍗曚负璋冪敤鏂瑰嚭鍙ｄ富鏈篒P闄愬埗璋冪敤IP
+
+## 濡備綍鎺ュ彛缁戝畾
+
+#### 搴旂敤缁戝畾鎺ュ彛
+
+鍦ㄦ湇鍔℃敞鍐�>鏈嶅姟娉ㄥ唽 涓偣鍑绘湇鍔＄粦瀹氾紝缁欐柊寤哄簲鐢ㄧ粦瀹氬凡鏈夋帴鍙ｏ紝绯荤粺鎷ユ湁鎺ュ彛鍙互鍦� 鏈嶅姟绠＄悊> 鏈嶅姟淇℃伅涓煡鐪�
+
+
+
+## 濡備綍璋冪敤鎺ュ彛
+
+#### 璋冪敤鍦板潃鎷兼帴
+
+鎺ュ彛鍦板潃鎷兼帴鏂瑰紡涓� https://鎮ㄧ殑IP:鎮ㄧ殑绔彛(service-front鐨勭鍙�8012)/app/鏈嶅姟缂栫爜 鎴栬�呬负
+https://鎮ㄧ殑IP:鎮ㄧ殑绔彛(service-api鐨勭鍙�8008)/api/鏈嶅姟缂栫爜
+
+绗竴涓湴鍧�涓哄彧鏈夊湪鐧诲綍鑾峰彇token鍚庢墠鑳借皟鐢紝绗簩涓湴鍧�涓嶉渶瑕佽幏鍙杢oken鐩存帴璋冪敤锛宻ervice-front 鐨勪綔鐢ㄤ负鏍￠獙 璋冪敤鏂规槸鍚︾櫥褰�
+
+
+#### 璋冪敤鍥哄畾浼犲弬浠嬬粛
+
+鎺ュ彛璋冪敤鍩烘湰闇�瑕佷紶涓�涓�4涓弬鏁板埌http header
+
+|鍙傛暟鍚嶇О|绾︽潫|绫诲瀷|闀垮害|鎻忚堪|鍙栧�艰鏄巪
+| :-: | :-: | :-: | :-: | :-: | :-:|
+|app-id|1|String|30|搴旂敤ID|閫氳繃娣诲姞搴旂敤鐢熸垚|
+|transaction-id|1|String|30|璇锋眰娴佹按鍙穦寤鸿涓簎uid|
+|sign|1|String|-|绛惧悕|璇峰弬鑰冪鍚嶈鏄巪
+|req-time|1|String|-|璇锋眰鏃堕棿|YYYYMMDDhhmmss|
+
+
+#### 涓句緥
+
+
+###### 涓句緥
+> 鍦板潃锛歔http://api.java110.com:8008/api/owner.queryOwnerMembers?memberId=772019091360360003&communityId=7020181217000001](http://api.java110.com:8008/api/owner.queryOwnerMembers?memberId=772019091360360003&communityId=7020181217000001)
+
+``` javascript
+璇锋眰澶翠俊鎭細
+Content-Type:application/json
+USER-ID:1234
+APP-ID:8000418002
+TRANSACTION-ID:10029082726
+REQ-TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+璇锋眰鎶ユ枃锛�
+
+鏃�
+
+杩斿洖鎶ユ枃锛�
+{
+ "machines": [{
+ "age": "1",
+ "machineId": "123",
+ "machineCode": "Acc009",
+ "machineVersion": "v1.0",
+ "machineName": "闂ㄧ澶ч棬浣嶇疆娴嬭瘯",
+ "locationTypeCd": "1000",
+ "locationObjName": "涓滃ぇ闂�",
+ "locationObjId": "7020181217000001"
+ }],
+ "page": 0,
+ "records": 1,
+ "rows": 0,
+ "total": 1
+}
+
+```
+
+
+
+## 鎺ュ彛绛惧悕
+
+```java
+
+ /**
+ * 鐢熸垚绛惧悕
+ *
+ * @param transactionId
+ * @return
+ */
+ public static String generatorSign(String transactionId, String requestTime, String param) throws NoAuthorityException {
+
+ if ("ON".equals(MappingCacheFactory.getValue("SIGN_FLAG"))) {
+ String reqInfo = transactionId + requestTime + MappingCacheFactory.getValue("APP_ID") + param + MappingCacheFactory.getValue("SECURITY_CODE");
+ return md5(reqInfo);
+ }
+ return "";
+ }
+
+ //get 鏂瑰紡璇锋眰 url 涓篻et璇锋眰鏃剁殑鍦板潃 SystemConstant.HTTP_TRANSACTION_ID 涓� header 涓� TRANSACTION-ID SystemConstant.HTTP_REQ_TIME
+ //涓篽eader 涓� REQ-TIME
+ String tempGetParam = "";
+ if (url.indexOf("?") > 0) {
+ tempGetParam = url.substring(url.indexOf("?"));
+ }
+ String paramIn = tempGetParam ;
+ // 鐢熸垚sign
+ String sign = generatorSign(httpHeaders.get(SystemConstant.HTTP_TRANSACTION_ID).get(0),
+ httpHeaders.get(SystemConstant.HTTP_REQ_TIME).get(0),
+ paramIn);
+
+ //post 鏂瑰紡璇锋眰 param 涓簆ost body鍐呭SystemConstant.HTTP_TRANSACTION_ID 涓� header 涓� TRANSACTION-ID SystemConstant.HTTP_REQ_TIME
+ //涓篽eader 涓� REQ-TIME
+ String tempGetParam = "";
+ String paramIn = param;
+ // 鐢熸垚sign
+ String sign = generatorSign(httpHeaders.get(SystemConstant.HTTP_TRANSACTION_ID).get(0),
+ httpHeaders.get(SystemConstant.HTTP_REQ_TIME).get(0),
+ paramIn);
+
+```
+
+
+
--
Gitblit v1.8.0