From cb90fedb52ec6eceb2ea61ba5f28a543cc29897c Mon Sep 17 00:00:00 2001
From: xuefei <564615061@qq.com>
Date: 星期四, 10 十二月 2020 14:32:23 +0800
Subject: [PATCH] 接口文档

---
 api.md |   79 +++++++++++++++++++++++++++++++++++++++
 1 files changed, 79 insertions(+), 0 deletions(-)

diff --git a/api.md b/api.md
new file mode 100644
index 0000000..ba886c4
--- /dev/null
+++ b/api.md
@@ -0,0 +1,79 @@
+鐩綍
+
+[1.閫氱敤](#1)  
+ &nbsp; &nbsp; [ 1.1鑾峰彇鎵�鏈夊尯鍩熸帴鍙(#1.1)  
+ 
+[2.棣栭〉](#2)  
+&nbsp; &nbsp; [ 2.1鑾峰彇鍖哄煙娲ヨ创缁熻](#2.1)
+  
+[3.琛ヨ创](#3) 
+  
+[4.鏈嶅姟瀵硅薄](#4) 
+
+[5.鏈嶅姟鏈烘瀯](#5) 
+
+<h3 id='1'>涓�銆侀�氱敤</h2>
+<h4 id='1.1'>1.1鑾峰彇鎵�鏈夊尯鍩熸帴鍙�</h4>
+###### 鎺ュ彛鍔熻兘
+> 鑾峰彇鎵�鏈夊尯鍩�
+
+###### URL
+> /api/getAllArea
+
+###### 鏀寔鏍煎紡
+> JSON
+
+###### HTTP璇锋眰鏂瑰紡
+> GET
+
+###### 璇锋眰鍙傛暟
+|鍙傛暟|蹇呴�墊绫诲瀷|璇存槑|
+|:-----  |:-------|:-----|-----                               |
+|    |    ||                          |
+
+###### 杩斿洖瀛楁
+|杩斿洖瀛楁|瀛楁绫诲瀷|璇存槑                              |
+|:-----   |:------|:-----------------------------   |
+|   |    |   |
+
+###### 鎺ュ彛绀轰緥
+``` java
+{
+    "statue": 0,
+    "company": "鍙彛鍙箰",
+    "category": "楗枡",
+}
+``` 
+
+<h3 id='2'>浜屻�侀椤�</h2>
+<h4 id='2.1'>2.1鑾峰彇鍖哄煙娲ヨ创缁熻</h4>
+###### 鎺ュ彛鍔熻兘
+> 鏍规嵁鍖哄煙鍚嶇О鑾峰彇娲ヨ创缁熻
+
+###### URL
+> /api/getAllArea
+
+###### 鏀寔鏍煎紡
+> JSON
+
+###### HTTP璇锋眰鏂瑰紡
+> GET
+
+###### 璇锋眰鍙傛暟
+|鍙傛暟|蹇呴�墊绫诲瀷|璇存槑|
+|:-----  |:-------|:-----|-----                               |
+|    |    ||                          |
+
+###### 杩斿洖瀛楁
+|杩斿洖瀛楁|瀛楁绫诲瀷|璇存槑                              |
+|:-----   |:------|:-----------------------------   |
+|   |    |   |
+
+###### 鎺ュ彛绀轰緥
+``` java
+{
+    "statue": 0,
+    "company": "鍙彛鍙箰",
+    "category": "楗枡",
+}
+``` 
\ No newline at end of file

--
Gitblit v1.9.1