docs: 新增接口文档

SwiftGGTeam · Sep 23, 2019 · 318f692 · 318f692
1 parent 6e947dd
commit 318f692
Showing 1 changed file with 38 additions and 0 deletions.
diff --git a/AppApiDoc.md b/AppApiDoc.md
@@ -6,6 +6,8 @@
 - [商品](#商品)
     - [商品列表](#商品列表)
     - [商品详情](#商品详情)
+- [活动](#活动)
+    - [活动列表](#活动列表)
 
 ## 通用请求返回格式
 ```json
@@ -201,3 +203,39 @@
     }
 }
 ```
+
+## 活动
+### 活动列表
+接口地址：`GET` `http://api.swift.gg/app/events`
+
+```json
+{
+    "success": true,
+    "message": "",
+    "results": {
+        "pageBean": {
+            "page": 1,
+            "size": 10,
+            "total": 2
+        },
+        "items": [
+            {
+                "name": "2019 力扣杯全国秋季编程大赛",
+                "state": "开放报名中",
+                "date": "2019-09-24 ~ 2019-09-25",
+                "place": "线上活动",
+                "imageURL": "https://activity-static.segmentfault.com/265/003/265003973-5d76265be94cc_big",
+                "registerURL": "https://leetcode-cn.com/contest/season/2019-fall/"
+            },
+            {
+                "name": "DDD领域驱动设计峰会",
+                "state": "开放报名中",
+                "date": "2019-11-28 ~ 2019-11-30",
+                "place": "北京市丽都皇冠假日酒店",
+                "imageURL": "https://activity-static.segmentfault.com/341/320/3413202100-5d4299e9be6b7_big",
+                "registerURL": "http://ddd-china.com"
+            }
+        ]
+    }
+}
+```