From ae6f2120027b49d50434f9cfcd76b5635110a8f2 Mon Sep 17 00:00:00 2001 From: "wenbo.dong" Date: Thu, 31 Aug 2017 11:55:24 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9E=84=E5=BB=BA=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E7=BB=93=E6=9E=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/manage/admin.md | 5 + doc/manage/build.md | 3 + doc/manage/intro.md | 0 doc/manage/update.md | 1 + doc/usage/authority.md | 0 doc/usage/case.md | 3 + doc/usage/getfamiliar.md | 7 + doc/usage/interface.md | 3 + doc/usage/leader.md | 3 + doc/usage/mock.md | 5 + doc/{interface.md => usage/quickstart.md} | 23 +- static/doc/api.html | 7 +- static/doc/index.html | 7 +- static/doc/manage-介绍.html | 177 ++++++++++++++ static/doc/manage-版本升级.html | 178 ++++++++++++++ static/doc/manage-超管职责.html | 193 +++++++++++++++ static/doc/manage-部署.html | 189 +++++++++++++++ static/doc/manage.html | 177 ++++++++++++++ static/doc/mock-使用mock功能.html | 211 +++++++++++++++++ static/doc/mock-使用测试集.html | 207 ++++++++++++++++ .../{start.html => mock-创建第一个API.html} | 78 ++++-- static/doc/mock-成为组长.html | 207 ++++++++++++++++ static/doc/mock-接口配置.html | 207 ++++++++++++++++ static/doc/mock-权限列表.html | 195 +++++++++++++++ static/doc/mock-认识 YApi.html | 215 +++++++++++++++++ static/doc/mock.html | 204 ++++------------ static/doc/usage-使用mock功能.html | 211 +++++++++++++++++ static/doc/usage-使用测试集.html | 207 ++++++++++++++++ static/doc/usage-创建第一个API.html | 224 ++++++++++++++++++ static/doc/usage-成为组长.html | 207 ++++++++++++++++ static/doc/usage-接口配置.html | 207 ++++++++++++++++ static/doc/usage-权限列表.html | 195 +++++++++++++++ static/doc/usage-认识 YApi.html | 215 +++++++++++++++++ static/doc/usage.html | 195 +++++++++++++++ ydoc.json | 86 ++++++- 35 files changed, 4055 insertions(+), 197 deletions(-) create mode 100644 doc/manage/admin.md create mode 100644 doc/manage/build.md create mode 100644 doc/manage/intro.md create mode 100644 doc/manage/update.md create mode 100644 doc/usage/authority.md create mode 100644 doc/usage/case.md create mode 100644 doc/usage/getfamiliar.md create mode 100644 doc/usage/interface.md create mode 100644 doc/usage/leader.md create mode 100644 doc/usage/mock.md rename doc/{interface.md => usage/quickstart.md} (80%) create mode 100644 static/doc/manage-介绍.html create mode 100644 static/doc/manage-版本升级.html create mode 100644 static/doc/manage-超管职责.html create mode 100644 static/doc/manage-部署.html create mode 100644 static/doc/manage.html create mode 100644 static/doc/mock-使用mock功能.html create mode 100644 static/doc/mock-使用测试集.html rename static/doc/{start.html => mock-创建第一个API.html} (66%) create mode 100644 static/doc/mock-成为组长.html create mode 100644 static/doc/mock-接口配置.html create mode 100644 static/doc/mock-权限列表.html create mode 100644 static/doc/mock-认识 YApi.html create mode 100644 static/doc/usage-使用mock功能.html create mode 100644 static/doc/usage-使用测试集.html create mode 100644 static/doc/usage-创建第一个API.html create mode 100644 static/doc/usage-成为组长.html create mode 100644 static/doc/usage-接口配置.html create mode 100644 static/doc/usage-权限列表.html create mode 100644 static/doc/usage-认识 YApi.html create mode 100644 static/doc/usage.html diff --git a/doc/manage/admin.md b/doc/manage/admin.md new file mode 100644 index 00000000..f71d4524 --- /dev/null +++ b/doc/manage/admin.md @@ -0,0 +1,5 @@ +## 用户管理 + +## 分配组长 + +## 维护数据库 diff --git a/doc/manage/build.md b/doc/manage/build.md new file mode 100644 index 00000000..c33f11bf --- /dev/null +++ b/doc/manage/build.md @@ -0,0 +1,3 @@ +## 快速部署 + +## 配置说明 diff --git a/doc/manage/intro.md b/doc/manage/intro.md new file mode 100644 index 00000000..e69de29b diff --git a/doc/manage/update.md b/doc/manage/update.md new file mode 100644 index 00000000..f4646f8e --- /dev/null +++ b/doc/manage/update.md @@ -0,0 +1 @@ +版本升级 diff --git a/doc/usage/authority.md b/doc/usage/authority.md new file mode 100644 index 00000000..e69de29b diff --git a/doc/usage/case.md b/doc/usage/case.md new file mode 100644 index 00000000..db7845cd --- /dev/null +++ b/doc/usage/case.md @@ -0,0 +1,3 @@ +## 介绍 + +## 使用说明 diff --git a/doc/usage/getfamiliar.md b/doc/usage/getfamiliar.md new file mode 100644 index 00000000..23aeb470 --- /dev/null +++ b/doc/usage/getfamiliar.md @@ -0,0 +1,7 @@ +## 登录与注册 + +## 首页 + +## 项目页 + +## 个人信息 diff --git a/doc/usage/interface.md b/doc/usage/interface.md new file mode 100644 index 00000000..26877c43 --- /dev/null +++ b/doc/usage/interface.md @@ -0,0 +1,3 @@ +## 介绍 + +## 配置说明 diff --git a/doc/usage/leader.md b/doc/usage/leader.md new file mode 100644 index 00000000..6322d692 --- /dev/null +++ b/doc/usage/leader.md @@ -0,0 +1,3 @@ +## 什么是组长 + +## 组长职责 diff --git a/doc/usage/mock.md b/doc/usage/mock.md new file mode 100644 index 00000000..a22b6aef --- /dev/null +++ b/doc/usage/mock.md @@ -0,0 +1,5 @@ +## 介绍 + +## 使用说明 + +## 模板语法 diff --git a/doc/interface.md b/doc/usage/quickstart.md similarity index 80% rename from doc/interface.md rename to doc/usage/quickstart.md index 4c209545..ef222a3e 100644 --- a/doc/interface.md +++ b/doc/usage/quickstart.md @@ -1,31 +1,34 @@ -## 快速开始 -### 1 创建项目分组 +## 起步 +### 创建API +注册新用户或使用 QSSO 登录。 + +新用户进入 YApi 时没有任何权限，只能浏览公开项目，想要创建 API 应联系 `组长` 将你添加到某分组或某项目中。 登录之后进到项目首页，左边侧边栏显示的即分组列表。 图片名称 -联系管理员添加分组并且把你设置为组长或让组长邀请你加入到某项目分组 -#### 2 项目列表 + +#### 项目列表 选中不同的分组，右边会显示该分组下的项目列表。 图片名称 -### 3 添加项目 +### 添加项目 -#### 3.1 点击右上角的“+“号进入添加项目页面 +- 点击右上角的“+“号进入添加项目页面 图片名称 -#### 3.2 添加项目页面 +- 添加项目页面 图片名称 添加完成后进去项目详情页面 -### 4 项目详情页面 +### 项目详情页面 -#### 4.1 添加接口分类 +#### 添加接口分类 图片名称 @@ -42,4 +45,4 @@ #### 4.4 测试接口 点击运行tab,可进入到接口测试页面，首先安装chrome crossRequest扩展，才可正常使用此功能 图片名称 -点击保存按钮可把当前测试保存到测试集，方便下次调试 \ No newline at end of file +点击保存按钮可把当前测试保存到测试集，方便下次调试 diff --git a/static/doc/api.html b/static/doc/api.html index 57d44d75..e9e8471c 100644 --- a/static/doc/api.html +++ b/static/doc/api.html @@ -31,7 +31,12 @@
  • - 快速开始 + 使用手册 +
    • + +
  • + + 管理学院
  • diff --git a/static/doc/index.html b/static/doc/index.html index 1e6ca67d..a2acc71d 100644 --- a/static/doc/index.html +++ b/static/doc/index.html @@ -31,7 +31,12 @@
  • - 快速开始 + 使用手册 +
    • + +
  • + + 管理学院
  • diff --git a/static/doc/manage-介绍.html b/static/doc/manage-介绍.html new file mode 100644 index 00000000..ee39bc2a --- /dev/null +++ b/static/doc/manage-介绍.html @@ -0,0 +1,177 @@ + + + + + + + + + + + YApi 管理学院 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    管理学院

    +

    超级管理员、分组/项目组长的学院。

    + +
    +
    + + +
    + +
    + + + + +
    + + +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/manage-版本升级.html b/static/doc/manage-版本升级.html new file mode 100644 index 00000000..0cbccc05 --- /dev/null +++ b/static/doc/manage-版本升级.html @@ -0,0 +1,178 @@ + + + + + + + + + + + YApi 管理学院 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    管理学院

    +

    超级管理员、分组/项目组长的学院。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    版本升级

    + +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/manage-超管职责.html b/static/doc/manage-超管职责.html new file mode 100644 index 00000000..6a00684e --- /dev/null +++ b/static/doc/manage-超管职责.html @@ -0,0 +1,193 @@ + + + + + + + + + + + YApi 管理学院 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    管理学院

    +

    超级管理员、分组/项目组长的学院。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    用户管理 #

    分配组长 #

    维护数据库 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/manage-部署.html b/static/doc/manage-部署.html new file mode 100644 index 00000000..17f474af --- /dev/null +++ b/static/doc/manage-部署.html @@ -0,0 +1,189 @@ + + + + + + + + + + + YApi 管理学院 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    管理学院

    +

    超级管理员、分组/项目组长的学院。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    快速部署 #

    配置说明 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/manage.html b/static/doc/manage.html new file mode 100644 index 00000000..03c90b91 --- /dev/null +++ b/static/doc/manage.html @@ -0,0 +1,177 @@ + + + + + + + + + + + YApi 管理学院 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    管理学院

    +

    超级管理员、分组/项目组长的学院。

    + +
    +
    + + +
    + +
    + + + + +
    + + +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/mock-使用mock功能.html b/static/doc/mock-使用mock功能.html new file mode 100644 index 00000000..12bd540d --- /dev/null +++ b/static/doc/mock-使用mock功能.html @@ -0,0 +1,211 @@ + + + + + + + + + + + YApi Mock功能 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    介绍 #

    使用说明 #

    模板语法 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/mock-使用测试集.html b/static/doc/mock-使用测试集.html new file mode 100644 index 00000000..c0f003c8 --- /dev/null +++ b/static/doc/mock-使用测试集.html @@ -0,0 +1,207 @@ + + + + + + + + + + + YApi Mock功能 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    介绍 #

    使用说明 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/start.html b/static/doc/mock-创建第一个API.html similarity index 66% rename from static/doc/start.html rename to static/doc/mock-创建第一个API.html index d57d88ae..33c3b295 100644 --- a/static/doc/start.html +++ b/static/doc/mock-创建第一个API.html @@ -8,7 +8,7 @@ - YApi 快速开始 + YApi Mock功能 @@ -29,13 +29,18 @@ 首页
    • -
  • +
  • - 快速开始 + 使用手册
  • + 管理学院 +
    • + +
  • + Mock功能
    • @@ -75,40 +80,73 @@
  • - 快速开始 + 认识 YApi +
    • + + +
  • + + 创建第一个API
    • + + +
  • + + 接口配置 +
    • + +
  • + + 使用mock功能 +
    • + + +
  • + + 使用测试集 +
    • + + +
  • + + 成为组长 +
    • + + +
  • + + 权限列表 +
    • +
    -

    快速开始 #

    1 创建项目分组 #

    登录之后进到项目首页，左边侧边栏显示的即分组列表。

    +

    起步 #

    创建API #

    注册新用户或使用 QSSO 登录。

    +

    新用户进入 YApi 时没有任何权限，只能浏览公开项目，想要创建 API 应联系 组长 将你添加到某分组或某项目中。 +登录之后进到项目首页，左边侧边栏显示的即分组列表。

    图片名称

    -

    联系管理员添加分组并且把你设置为组长或让组长邀请你加入到某项目分组

    -

    2 项目列表 #

    选中不同的分组，右边会显示该分组下的项目列表。

    +

    项目列表 #

    选中不同的分组，右边会显示该分组下的项目列表。

    图片名称

    -

    3 添加项目 #

    3.1 点击右上角的“+“号进入添加项目页面 #

    图片名称

    -

    3.2 添加项目页面 #

    图片名称 +

    添加项目 #

    +

    项目详情页面 #

    添加接口分类 #

    图片名称

    添加完成后可以在左侧列表看到新添加的接口分类

    4.2 添加接口 #

    鼠标移动到接口分类的菜单icon，点击添加接口

    图片名称

    diff --git a/static/doc/mock-成为组长.html b/static/doc/mock-成为组长.html new file mode 100644 index 00000000..15d83207 --- /dev/null +++ b/static/doc/mock-成为组长.html @@ -0,0 +1,207 @@ + + + + + + + + + + + YApi Mock功能 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    什么是组长 #

    组长职责 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/mock-接口配置.html b/static/doc/mock-接口配置.html new file mode 100644 index 00000000..84754bd2 --- /dev/null +++ b/static/doc/mock-接口配置.html @@ -0,0 +1,207 @@ + + + + + + + + + + + YApi Mock功能 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    介绍 #

    配置说明 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/mock-权限列表.html b/static/doc/mock-权限列表.html new file mode 100644 index 00000000..0e729702 --- /dev/null +++ b/static/doc/mock-权限列表.html @@ -0,0 +1,195 @@ + + + + + + + + + + + YApi Mock功能 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + + +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/mock-认识 YApi.html b/static/doc/mock-认识 YApi.html new file mode 100644 index 00000000..9b9851e1 --- /dev/null +++ b/static/doc/mock-认识 YApi.html @@ -0,0 +1,215 @@ + + + + + + + + + + + YApi Mock功能 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    登录与注册 #

    首页 #

    项目页 #

    个人信息 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/mock.html b/static/doc/mock.html index acae36ed..f5f6f3bd 100644 --- a/static/doc/mock.html +++ b/static/doc/mock.html @@ -31,7 +31,12 @@
  • - 快速开始 + 使用手册 +
    • + +
  • + + 管理学院
  • @@ -75,173 +80,52 @@
  • - Mock介绍 + 认识 YApi
    • - - + +
  • + + 创建第一个API +
    • + + +
  • + + 接口配置 +
    • + + +
  • + + 使用mock功能 +
    • + + +
  • + + 使用测试集 +
    • + + +
  • + + 成为组长 +
    • + + +
  • + + 权限列表 +
    • +
    -

    Mock介绍 #

    yapi的Mock功能可以根据用户的输入接口信息如协议、URL、接口名、请求头、请求参数、mock规则(点击到Mock规则）生成Mock接口，这些接口会自动生成模拟数据，创建者可以自由构造需要的数据。而且与常见的Mock方式如将Mock写在代码里和JS拦截等相比yapi的Mock在使用场景和效率和复杂度上是相差甚远的，正是由于yapi的Mock是一个第三方平台，那么在团队开发时任何人都可以权限许可下创建、修改接口信息等操作，这对于团队开发是很有好处的。

    -

    mock地址解析：yapi平台网址+mock+您的项目id+接口实际请求path

    -

    注：项目id可以在项目设置里查看到

    -

    -

    -

    1 如何使用Mock? #

    1.1 最简单最直接的方式 #

    在代码直接请求yapi提供的mock地址，以jQuery为例：

    -
    let prefix = 'http://yapi.local.qunar.com:3000/mock/2817'
-$.post(prefix+'/baseapi/path', {username: 'xxx'}, function(res){
-    console.log(res) //返回上图预览部分的数据
-})
-
    -

    1.2 基于本地服务器反向代理 #

    优点:不用修改项目代码

    -

    1.2.1 基于nginx反向代理 #

    location /baseapi
-{
-proxy_pass   http://yapi.local.qunar.com:3000/mock/2817/baseapi; #baseapi后面没有"/"
-}
-
    -

    1.2.2 基于ykit Jerry代理 #

    假设您本地服务器访问地址是： http://xxx.com

    -

    -

    -

    2.1 Mock语法规范 #

    -

    了解更多Mock详情：Mock.js 官方文档

    -
    -

    Mock.js 的语法规范包括两部分：

    -

    1. 数据模板定义规范（Data Template Definition，DTD）

    -

    2. 数据占位符定义规范（Data Placeholder Definition，DPD）

    -

    -

    数据模板定义规范（Data Template Definition，DTD） #

    数据模板中的每个属性由 3 部分构成：属性名、生成规则、属性值：

    -
    // 属性名   name （与生成规则之间用 "|" 隔开）
-// 生成规则 rule（生成规则有7种详见下面的生成规则）
-// 属性值   value（可以含有 "@占位符" 同时也指定了最终值的初始值和类型）
-
-'name|rule': value
-
-生成规则：
-'name|min-max': value
-'name|count': value
-'name|min-max.dmin-dmax': value
-'name|min-max.dcount': value
-'name|count.dmin-dmax': value
-'name|count.dcount': value
-'name|+step': value
-

    下面提供了6种生成规则以及示例包括 String、Number、Boolean、Object、Array：

    -

    1. 属性值是字符串 String #

    1. 'name|min-max': string
-
-通过重复 string 生成一个字符串，重复次数大于等于 min，小于等于 max。
-
-2. 'name|count': string
-
-通过重复 string 生成一个字符串，重复次数等于 count。
-

    2. 属性值是数字 Number #

    1. 'name|+1': number
-
-属性值自动加 1，初始值为 number。
-
-2. 'name|min-max': number
-
-生成一个大于等于 min、小于等于 max 的整数，属性值 number 只是用来确定类型。
-
-3. 'name|min-max.dmin-dmax': number
-
-生成一个浮点数，整数部分大于等于 min、小于等于 max，小数部分保留 dmin 到 dmax 位。
-
-例如：
-Mock.mock({
-    'number1|1-100.1-10': 1,
-    'number2|123.1-10': 1,
-    'number3|123.3': 1,
-    'number4|123.10': 1.123
-})
-// =>
-{
-    "number1": 12.92,
-    "number2": 123.51,
-    "number3": 123.777,
-    "number4": 123.1231091814
-}
-

    3. 属性值是布尔型 Boolean #

    1. 'name|1': boolean
-
-随机生成一个布尔值，值为 true 的概率是 1/2，值为 false 的概率同样是 1/2。
-
-2. 'name|min-max': value
-
-随机生成一个布尔值，值为 value 的概率是 min / (min + max)，值为 !value 的概率是 max / (min + max)。
-

    4. 属性值是对象 Object #

    1. 'name|count': object
-
-从属性值 object 中随机选取 count 个属性。
-
-2. 'name|min-max': object
-
-从属性值 object 中随机选取 min 到 max 个属性。
-

    5. 属性值是数组 Array #

    1. 'name|1': array
-
-从属性值 array 中随机选取 1 个元素，作为最终值。
-
-2. 'name|+1': array
-
-从属性值 array 中顺序选取 1 个元素，作为最终值。
-
-3. 'name|min-max': array
-
-通过重复属性值 array 生成一个新数组，重复次数大于等于 min，小于等于 max。
-
-4. 'name|count': array
-
-通过重复属性值 array 生成一个新数组，重复次数为 count。
-

    -

    数据占位符定义规范（Data Placeholder Definition，DPD） #

    占位符 只是在属性值字符串中占个位置，并不出现在最终的属性值中。
-
-占位符 的格式为：
-
-@占位符
-
-说明：
-1. 用 @ 来标识其后的字符串是 占位符，在YApi提供的Mock输入框在输入“@”后会自动提示占位符。
-
-例如：
-name: {
-    first: '@FIRST',
-    middle: '@FIRST',
-    last: '@LAST',
-    full: '@first @middle @last'
-}
-// 上面的示例可以得到如下结果：
-"name": {
-    "first": "Charles",
-    "middle": "Brenda",
-    "last": "Lopez",
-    "full": "Charles Brenda Lopez"
-}
-
    +

    登录与注册 #

    首页 #

    项目页 #

    个人信息 #

    diff --git a/static/doc/usage-使用mock功能.html b/static/doc/usage-使用mock功能.html new file mode 100644 index 00000000..c4f51718 --- /dev/null +++ b/static/doc/usage-使用mock功能.html @@ -0,0 +1,211 @@ + + + + + + + + + + + YApi 使用手册 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    介绍 #

    使用说明 #

    模板语法 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/usage-使用测试集.html b/static/doc/usage-使用测试集.html new file mode 100644 index 00000000..a707ed9e --- /dev/null +++ b/static/doc/usage-使用测试集.html @@ -0,0 +1,207 @@ + + + + + + + + + + + YApi 使用手册 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    介绍 #

    使用说明 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/usage-创建第一个API.html b/static/doc/usage-创建第一个API.html new file mode 100644 index 00000000..9b7e1be3 --- /dev/null +++ b/static/doc/usage-创建第一个API.html @@ -0,0 +1,224 @@ + + + + + + + + + + + YApi 使用手册 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    起步 #

    创建API #

    注册新用户或使用 QSSO 登录。

    +

    新用户进入 YApi 时没有任何权限，只能浏览公开项目，想要创建 API 应联系 组长 将你添加到某分组或某项目中。 +登录之后进到项目首页，左边侧边栏显示的即分组列表。

    +

    图片名称

    +

    项目列表 #

    选中不同的分组，右边会显示该分组下的项目列表。

    +

    图片名称

    +

    添加项目 #

      +

    • 点击右上角的“+“号进入添加项目页面 +图片名称

      +

    • 添加项目页面 +图片名称 +添加完成后进去项目详情页面

      +
    +

    项目详情页面 #

    添加接口分类 #

    图片名称

    +

    添加完成后可以在左侧列表看到新添加的接口分类

    +

    4.2 添加接口 #

    鼠标移动到接口分类的菜单icon，点击添加接口

    +

    图片名称

    +

    4.3 接口编辑 #

    添加完接口点击新添加的接口，跳转到接口预览页面，可看到刚才填写的信息。接口的详细信息点击编辑功能进行添加

    +

    4.4 测试接口 #

    点击运行tab,可进入到接口测试页面，首先安装chrome crossRequest扩展，才可正常使用此功能 +图片名称 +点击保存按钮可把当前测试保存到测试集，方便下次调试

    + +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/usage-成为组长.html b/static/doc/usage-成为组长.html new file mode 100644 index 00000000..51639dc9 --- /dev/null +++ b/static/doc/usage-成为组长.html @@ -0,0 +1,207 @@ + + + + + + + + + + + YApi 使用手册 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    什么是组长 #

    组长职责 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/usage-接口配置.html b/static/doc/usage-接口配置.html new file mode 100644 index 00000000..afa285fd --- /dev/null +++ b/static/doc/usage-接口配置.html @@ -0,0 +1,207 @@ + + + + + + + + + + + YApi 使用手册 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    介绍 #

    配置说明 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/usage-权限列表.html b/static/doc/usage-权限列表.html new file mode 100644 index 00000000..0e35493f --- /dev/null +++ b/static/doc/usage-权限列表.html @@ -0,0 +1,195 @@ + + + + + + + + + + + YApi 使用手册 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + + +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/usage-认识 YApi.html b/static/doc/usage-认识 YApi.html new file mode 100644 index 00000000..010aa290 --- /dev/null +++ b/static/doc/usage-认识 YApi.html @@ -0,0 +1,215 @@ + + + + + + + + + + + YApi 使用手册 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    登录与注册 #

    首页 #

    项目页 #

    个人信息 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/static/doc/usage.html b/static/doc/usage.html new file mode 100644 index 00000000..24068d38 --- /dev/null +++ b/static/doc/usage.html @@ -0,0 +1,195 @@ + + + + + + + + + + + YApi 使用手册 + + + + + +
    +
    +
    + + YMFE + + + +
    +
    + + + + + +
    +
    +
    +

    YApi

    +

    高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    + +
    +
    + + +
    + +
    + + + + +
    + +

    登录与注册 #

    首页 #

    项目页 #

    个人信息 #

    +
    +
    + +
    + +
    + +
    +
    + © 2016 YMFE Team. Build by ydoc. +
    +
    +
    + + +
    +
    + + + + + + + + + + + diff --git a/ydoc.json b/ydoc.json index a1974321..4ddd44f8 100644 --- a/ydoc.json +++ b/ydoc.json @@ -58,13 +58,64 @@ }, "content": "./doc/home.md" // 内容(这里以markdown文件举例) },{ - "name": "start", // Page Name 会根据他生成 html 文件，例: index.html - "title": "快速开始", // Page Title + "name": "usage", // Page Name 会根据他生成 html 文件，例: index.html + "title": "使用手册", // Page Title "banner": { // Banner 配置 "title": "YApi", "description": "高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。" }, - "content": "./doc/interface.md" // 内容(这里以markdown文件举例) + "content": { + "sidebar": true, + "multi": true, + "index": "./doc/usage/getfamiliar.md", + "pages": [{ + "name": "认识 YApi", + "content": "./doc/usage/getfamiliar.md" + }, { + "name": "创建第一个API", + "content": "./doc/usage/quickstart.md" + }, { + "name": "接口配置", + "content": "./doc/usage/interface.md" + }, { + "name": "使用mock功能", + "content": "./doc/usage/mock.md" + }, { + "name": "使用测试集", + "content": "./doc/usage/case.md" + }, { + "name": "成为组长", + "content": "./doc/usage/leader.md" + }, { + "name": "权限列表", + "content": "./doc/usage/authority.md" + }] + } + },{ + "name": "manage", + "title": "管理学院", + "banner": { + "title": "管理学院", + "description": "超级管理员、分组/项目组长的学院。" + }, + "content": { + "sidebar": true, + "multi": true, + "index": "./doc/manage/intro.md", + "pages": [{ + "name": "介绍", + "content": "./doc/manage/intro.md" + }, { + "name": "部署", + "content": "./doc/manage/build.md" + }, { + "name": "超管职责", + "content": "./doc/manage/admin.md" + }, { + "name": "版本升级", + "content": "./doc/manage/update.md" + }] + } },{ "name": "mock", // Page Name 会根据他生成 html 文件，例: index.html "title": "Mock功能", // Page Title @@ -72,8 +123,33 @@ "title": "YApi", "description": "高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。" }, - "content": "./doc/mock.md" // 内容(这里以markdown文件举例) - + "content": { + "sidebar": true, + "multi": true, + "index": "./doc/usage/getfamiliar.md", + "pages": [{ + "name": "认识 YApi", + "content": "./doc/usage/getfamiliar.md" + }, { + "name": "创建第一个API", + "content": "./doc/usage/quickstart.md" + }, { + "name": "接口配置", + "content": "./doc/usage/interface.md" + }, { + "name": "使用mock功能", + "content": "./doc/usage/mock.md" + }, { + "name": "使用测试集", + "content": "./doc/usage/case.md" + }, { + "name": "成为组长", + "content": "./doc/usage/leader.md" + }, { + "name": "权限列表", + "content": "./doc/usage/authority.md" + }] + } },{ "name": "api", "title": "",