From 9f1b86db4e224dd2f8a31e0dc7f56cfd3c93d548 Mon Sep 17 00:00:00 2001 From: "wenbo.dong" Date: Fri, 29 Sep 2017 22:11:58 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0demo=E9=93=BE?= =?UTF-8?q?=E6=8E=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- static/doc/api.html | 403 ++++++++++++++++++++++++++++++++++++ static/doc/case.html | 5 + static/doc/data.html | 5 + static/doc/getfamiliar.html | 5 + static/doc/index.html | 5 + static/doc/interface.html | 5 + static/doc/manage.html | 5 + static/doc/mock.html | 5 + static/doc/project.html | 5 + static/doc/qa.html | 5 + static/doc/quickstart.html | 5 + static/doc/releases.html | 5 + ydoc.json | 4 + 13 files changed, 462 insertions(+) diff --git a/static/doc/api.html b/static/doc/api.html index 3bafb09c..de27e1a8 100644 --- a/static/doc/api.html +++ b/static/doc/api.html @@ -38,6 +38,11 @@ 版本记录 +
  • + + YApi Demo +
    • +
  • @@ -161,6 +166,10 @@ /user/upload_avatar
    • +
  • + /user/avatar +
    • +
  • /user/search
    • @@ -183,10 +192,22 @@ /project/add +
  • + /project/add_member +
    • + +
  • + /project/del_member +
    • +
  • /project/get_member_list
    • +
  • + /project/get +
    • +
  • /project/list
    • @@ -244,6 +265,10 @@
  • /interface/del
    • + +
  • + /interface/getCatMenu +
    • @@ -1697,6 +1722,68 @@ + + +
    +
    +

    + /user/avatar + + GET + + + # +

    +
    +

    + 描述: + 根据用户uid头像 +

    + +

    + 源码位置: + ./server/controllers/user.js:495 +

    + + +

    + 参数: +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    参数名类型描述必选支持版本
    uid* + + + +
    +
    + + +
    @@ -1993,6 +2080,174 @@ } +
    + +
    +
    +

    + /project/add_member + + POST + + + # +

    +
    +

    + 描述: + 添加项目成员 +

    + +

    + 源码位置: + ./server/controllers/project.js:148 +

    + + +

    + 参数: +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    参数名类型描述必选支持版本
    idNumber项目id，不能为空 + + + +
    member_uidString项目成员uid,不能为空 + + + +
    +
    + + +
    示例：
    + 
    {
+    "errcode": 0,
+    "errmsg": "success",
+    "data": {
+        "n": 1,
+        "ok": 1
+    }
+}
    + + +
    + +
    +
    +

    + /project/del_member + + POST + + + # +

    +
    +

    + 描述: + 删除项目成员 +

    + +

    + 源码位置: + ./server/controllers/project.js:201 +

    + + +

    + 参数: +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    参数名类型描述必选支持版本
    idNumber项目id，不能为空 + + + +
    uidmember_uid项目成员uid,不能为空 + + + +
    +
    + + +
    示例：
    + 
    {
+    "errcode": 0,
+    "errmsg": "success",
+    "data": {
+        "n": 1,
+        "ok": 1
+    }
+}
    + +
    @@ -2071,6 +2326,89 @@ +
    + +
    +
    +

    + /project/get + + GET + + + # +

    +
    +

    + 描述: + 获取项目信息 +

    + +

    + 源码位置: + ./server/controllers/project.js:289 +

    + + +

    + 参数: +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    参数名类型描述必选支持版本
    idNumber项目id，不能为空 + + + +
    +
    + + +
    示例：
    + 
    {
+    "errcode": 0,
+    "errmsg": "success",
+    "data": {
+        "_id": 7,
+        "name": "project_a1",
+        "desc": "tttttt",
+        "prd_host": "project.a1.cc",
+        "basepath": "/a1",
+        "uid": 0,
+        "group_id": 1,
+        "add_time": 1499331378,
+        "up_time": 1499331378,
+        "__v": 0,
+        "members": [
+            0
+        ]
+    }
+}
    + +
    @@ -3598,6 +3936,71 @@ } +
    + +
    +
    +

    + /interface/getCatMenu + + GET + + + # +

    +
    +

    + 描述: + 获取分类列表 +

    + +

    + 源码位置: + ./server/controllers/interface.js:615 +

    + + +

    + 参数: +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    参数名类型描述必选支持版本
    project_idNumber项目id，不能为空 + + + +
    +
    + + +
    示例：
    + 
    ./api/interface/getCatMenu
    + +
    diff --git a/static/doc/case.html b/static/doc/case.html index 7c729711..c8e758dd 100644 --- a/static/doc/case.html +++ b/static/doc/case.html @@ -38,6 +38,11 @@ 版本记录 +
  • + + YApi Demo +
    • +
  • diff --git a/static/doc/data.html b/static/doc/data.html index 7b82cba7..ce8d8240 100644 --- a/static/doc/data.html +++ b/static/doc/data.html @@ -38,6 +38,11 @@ 版本记录
    • +
  • + + YApi Demo +
    • +
  • diff --git a/static/doc/getfamiliar.html b/static/doc/getfamiliar.html index 927b63ed..6df1be96 100644 --- a/static/doc/getfamiliar.html +++ b/static/doc/getfamiliar.html @@ -38,6 +38,11 @@ 版本记录
    • +
  • + + YApi Demo +
    • +
  • diff --git a/static/doc/index.html b/static/doc/index.html index 3cf13594..196267eb 100644 --- a/static/doc/index.html +++ b/static/doc/index.html @@ -38,6 +38,11 @@ 版本记录
    • +
  • + + YApi Demo +
    • +
  • diff --git a/static/doc/interface.html b/static/doc/interface.html index 7b934fe4..52c76555 100644 --- a/static/doc/interface.html +++ b/static/doc/interface.html @@ -38,6 +38,11 @@ 版本记录
    • +
  • + + YApi Demo +
    • +
  • diff --git a/static/doc/manage.html b/static/doc/manage.html index eb401b92..9d95a3be 100644 --- a/static/doc/manage.html +++ b/static/doc/manage.html @@ -38,6 +38,11 @@ 版本记录
    • +
  • + + YApi Demo +
    • +
  • diff --git a/static/doc/mock.html b/static/doc/mock.html index 396f6f62..d65da570 100644 --- a/static/doc/mock.html +++ b/static/doc/mock.html @@ -38,6 +38,11 @@ 版本记录
    • +
  • + + YApi Demo +
    • +
  • diff --git a/static/doc/project.html b/static/doc/project.html index 0fa79d47..057f5ebd 100644 --- a/static/doc/project.html +++ b/static/doc/project.html @@ -38,6 +38,11 @@ 版本记录
    • +
  • + + YApi Demo +
    • +
  • diff --git a/static/doc/qa.html b/static/doc/qa.html index 7616a641..5400f08a 100644 --- a/static/doc/qa.html +++ b/static/doc/qa.html @@ -38,6 +38,11 @@ 版本记录
    • +
  • + + YApi Demo +
    • +
  • diff --git a/static/doc/quickstart.html b/static/doc/quickstart.html index 7390e94e..7ccdbb36 100644 --- a/static/doc/quickstart.html +++ b/static/doc/quickstart.html @@ -38,6 +38,11 @@ 版本记录
    • +
  • + + YApi Demo +
    • +
  • diff --git a/static/doc/releases.html b/static/doc/releases.html index f74e8472..57f73d52 100644 --- a/static/doc/releases.html +++ b/static/doc/releases.html @@ -38,6 +38,11 @@ 版本记录
    • +
  • + + YApi Demo +
    • +
  • diff --git a/ydoc.json b/ydoc.json index 352cac35..de3e08b7 100644 --- a/ydoc.json +++ b/ydoc.json @@ -104,6 +104,10 @@ "compile": "markdown", "menuLevel": 2, "content": "./CHANGELOG.md" + },{ + "name": "YApi Demo", + "title": "YApi Demo", + "url": "http://yapi.demo.qunar.com/" }, { "name": "api",