mirror/yapi
2
0
Fork 0
mirror of https://github.com/YMFE/yapi.git synced 2025-01-30 13:20:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dev-doc' into doc

Browse Source
This commit is contained in:
suxiaoxin 2017-10-13 20:38:24 +08:00
commit ececef0bb2
19 changed files with 88 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -1,5 +1,5 @@
## 1.1
## 1.1.0
### Features
* 新增个人空间功能，拥有这个分组的全部权限，可以在这个分组里探索 YApi 的功能
* 新增分组动态功能

BIN
doc/images/usage/login.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 273 KiB

After

Width:  |  Height:  |  Size: 172 KiB

7
doc/page/manage/build.md
View File

@ -20,10 +20,13 @@ npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi-cli server
```
## 更新
## 升级
升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。
cd {项目目录}
yapi-cli ls //查看版本号列表
yapi-cli update -v v1.1.0
yapi-cli update //升级到最新版本
yapi-cli update -v v1.1.0 //升级到指定版本
## 配置邮箱 (仅支持 SMTP)
打开项目目录 config.json 文件，新增 mail 配置， 替换默认的邮箱配置

18
doc/page/plugin/hooks.md
View File

@ -8,6 +8,7 @@ var hooks = {
/**
* 第三方sso登录钩子，暂只支持设置一个
* @param ctx
* @return 必需返回一个 promise 对象，resolve({username: '', email: ''})
*/
'third_login': {
type: 'single',
@ -121,6 +122,23 @@ hooks = {
mulit: false,
listener: null
},
/**
* 导出数据
* @param Object exportDataModule
* @param projectId
* @info
* exportDataModule = {};
* exportDataModule.pdf = {
* name: 'Pdf',
* route: '/api/plugin/export/pdf',
* desc: '导出项目接口文档为 pdf 文件'
* }
*/
export_data: {
type: 'listener',
mulit: true,
listener: []
},
/**
* 导入数据
* @param importDataModule

3
doc/page/plugin/list.md
View File

@ -1,3 +1,6 @@
## 怎么分享我的插件？
Fork github.com/ymfe/yapi ，编辑根目录下的 plugin.json 文件， 然后 Pull-Request 到 ymfe/yapi
## 插件列表
<ul id="list">

2
doc/page/usage/getfamiliar.md
View File

@ -4,7 +4,7 @@ YApi 是高效、易用、功能强大的api管理平台。
在开始使用 YApi 之前，我们先来熟悉一下 YApi 的网站结构，这将让你快速了解YApi。
## 登录与注册
想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。
想要使用 YApi ，首先要注册账号。
<img src="./images/usage/login.png" />

8
doc/page/usage/qa.md
View File

@ -4,7 +4,7 @@
## Q1: 怎样联系组长？
A: 组长分为 `分组组长` 和 `项目组长`:
组长分为 `分组组长` 和 `项目组长`:
- 分组组长：选择首页左侧的分组，点击右侧面板的 `成员列表`，成员右侧显示着 `组长/开发者` 的权限信息。
<img src="./images/usage/manage_find_manager.png" />
- 项目组长: 点击项目页的 `设置` - `成员列表`，成员右侧显示着 `组长/开发者` 的权限信息。
@ -18,4 +18,8 @@ A: 组长分为 `分组组长` 和 `项目组长`:
第三步 将Har数据导入到YApi平台
具体使用方法请参考YApi<a href="./data.html#HAR%08%08_数据导入">文档</a>
具体使用方法请参考YApi<a href="./data.html#HAR%08%08_数据导入">文档</a>
## Q3: 忘记密码怎么办？
请联系 `超级管理员` ，只有超级管理员能重置密码。

6
doc/page/usage/quickstart.md
View File

@ -13,9 +13,11 @@
## 获取权限
新用户登录后没有任何项目或分组的权限，只能浏览已存在分组下面的公开项目。
新用户登录拥有 `个人空间` 分组下的全部权限，个人空间分组仅自己可见，因此可以在这里任意试用 YApi 的功能。
如果找不到想找的项目，可能是未成为项目成员，此时应联系 `项目组长` 将你加入该项目。
除此以外没有任何项目或分组的权限，只能浏览已存在分组下面的公开项目。
如果找不到想找的项目，可能是尚未成为项目成员，此时应联系 `项目组长` 将你加入该项目。
[怎样联系组长？](./qa.html#Q__怎样联系组长？)

4
static/doc/api.html
View File

@ -3894,7 +3894,7 @@
<p>
<small class="text-muted">源码位置:</small>
<a href="./static/server/controllers/interface.js.html#427" target="_blank">./server/controllers/interface.js:427</a>
<a href="./static/server/controllers/interface.js.html#429" target="_blank">./server/controllers/interface.js:429</a>
</p>
@ -3966,7 +3966,7 @@
<p>
<small class="text-muted">源码位置:</small>
<a href="./static/server/controllers/interface.js.html#615" target="_blank">./server/controllers/interface.js:615</a>
<a href="./static/server/controllers/interface.js.html#617" target="_blank">./server/controllers/interface.js:617</a>
</p>

8
static/doc/devops.html
View File

@ -92,7 +92,7 @@
<!-- <li > -->
<li >
<a href="#更新">更新</a>
<a href="#升级">升级</a>
</li>
<!-- <li > -->
@ -118,9 +118,11 @@ proxy_set_header Connection <span class="token string">"upgrade"</span><span cla
<h2 class="subject" id="安装">安装 <a class="hashlink" href="#安装">#</a></h2><p>执行 yapi-cli server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。</p>
<pre><code>npm install -g yapi-cli --registry https<span class="token operator">:</span>//registry.npm.taobao.org
yapi-cli server
</code></pre><h2 class="subject" id="更新">更新 <a class="hashlink" href="#更新">#</a></h2><pre><code>cd <span class="token punctuation">{</span>项目目录<span class="token punctuation">}</span>
</code></pre><h2 class="subject" id="升级">升级 <a class="hashlink" href="#升级">#</a></h2><p>升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。</p>
<pre><code>cd <span class="token punctuation">{</span>项目目录<span class="token punctuation">}</span>
yapi-cli ls //查看版本号列表
yapi-cli update -v v1<span class="token number">.1</span>.<span class="token number">0</span>
yapi-cli update //升级到最新版本
yapi-cli update -v v1<span class="token number">.1</span>.<span class="token number">0</span> //升级到指定版本
</code></pre><h2 class="subject" id="配置邮箱__仅支持_SMTP_">配置邮箱 (仅支持 SMTP) <a class="hashlink" href="#配置邮箱__仅支持_SMTP_">#</a></h2><p>打开项目目录 config.json 文件，新增 mail 配置， 替换默认的邮箱配置</p>
<pre><code><span class="token punctuation">{</span>
<span class="token property">"port"</span><span class="token operator">:</span> <span class="token string">"*****"</span><span class="token punctuation">,</span>

2
static/doc/getfamiliar.html
View File

@ -169,7 +169,7 @@
<p>YApi 是高效、易用、功能强大的api管理平台。
<!-- 它有扁平化的管理结构(`超管`-`组长`-`组员`)，有清晰的接口组织方式(`分组`-`项目`-`接口`)，有更方便的mock方案。 --></p>
<p>在开始使用 YApi 之前，我们先来熟悉一下 YApi 的网站结构，这将让你快速了解YApi。</p>
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。</p>
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ，首先要注册账号。</p>
<p><img src="./images/usage/login.png" /></p>
<h2 class="subject" id="首页">首页 <a class="hashlink" href="#首页">#</a></h2><p>登录后进入首页，首页展示了分组与项目。</p>
<p>此时你作为新用户，没有任何分组与项目的权限，因此只能搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。</p>

BIN
static/doc/images/usage/login.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 273 KiB

After

Width:  |  Height:  |  Size: 172 KiB

2
static/doc/index.html
View File

@ -149,7 +149,7 @@
<p>YApi 是高效、易用、功能强大的api管理平台。
<!-- 它有扁平化的管理结构(`超管`-`组长`-`组员`)，有清晰的接口组织方式(`分组`-`项目`-`接口`)，有更方便的mock方案。 --></p>
<p>在开始使用 YApi 之前，我们先来熟悉一下 YApi 的网站结构，这将让你快速了解YApi。</p>
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。</p>
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ，首先要注册账号。</p>
<p><img src="./images/usage/login.png" /></p>
<h2 class="subject" id="首页">首页 <a class="hashlink" href="#首页">#</a></h2><p>登录后进入首页，首页展示了分组与项目。</p>
<p>此时你作为新用户，没有任何分组与项目的权限，因此只能搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。</p>

18
static/doc/plugin-hooks.html
View File

@ -136,6 +136,7 @@ var hooks = <span class="token punctuation">{</span>
/**
* 第三方sso登录钩子，暂只支持设置一个
* @param ctx
* @return 必需返回一个 promise 对象，resolve(<span class="token punctuation">{</span>username<span class="token operator">:</span> ''<span class="token punctuation">,</span> email<span class="token operator">:</span> ''<span class="token punctuation">}</span><span class="token punctuation">)</span>
*/
'third_login'<span class="token operator">:</span> <span class="token punctuation">{</span>
type<span class="token operator">:</span> 'single'<span class="token punctuation">,</span>
@ -245,6 +246,23 @@ hooks = <span class="token punctuation">{</span>
mulit<span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span>
listener<span class="token operator">:</span> <span class="token null">null</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
/**
* 导出数据
* @param Object exportDataModule
* @param projectId
* @info
* exportDataModule = <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">;</span>
* exportDataModule.pdf = <span class="token punctuation">{</span>
* name<span class="token operator">:</span> 'Pdf'<span class="token punctuation">,</span>
* route<span class="token operator">:</span> '/api/plugin/export/pdf'<span class="token punctuation">,</span>
* desc<span class="token operator">:</span> '导出项目接口文档为 pdf 文件'
* <span class="token punctuation">}</span>
*/
export_data<span class="token operator">:</span> <span class="token punctuation">{</span>
type<span class="token operator">:</span> 'listener'<span class="token punctuation">,</span>
mulit<span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span>
listener<span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
/**
* 导入数据
* @param importDataModule

9
static/doc/plugin-list.html
View File

@ -110,8 +110,12 @@
<a href="plugin-list.html">插件列表</a>
</li>
<ul class="nav docs-sidenav-extend" style="display:block;" >
<ul class="nav docs-sidenav-extend" >
<li >
<a href="#怎么分享我的插件？">怎么分享我的插件？</a>
</li>
<li class="active" >
<a href="#插件列表">插件列表</a>
</li>
@ -124,7 +128,8 @@
<div class="content-right markdown-body use-sidebar" role="main">
<h2 class="subject" id="插件列表">插件列表 <a class="hashlink" href="#插件列表">#</a></h2><ul id="list">
<h2 class="subject" id="怎么分享我的插件？">怎么分享我的插件？ <a class="hashlink" href="#怎么分享我的插件？">#</a></h2><p>Fork github.com/ymfe/yapi ，编辑根目录下的 plugin.json 文件， 然后 Pull-Request 到 ymfe/yapi</p>
<h2 class="subject" id="插件列表">插件列表 <a class="hashlink" href="#插件列表">#</a></h2><ul id="list">
</ul>

7
static/doc/qa.html
View File

@ -149,6 +149,10 @@
<li >
<a href="#Q2__怎么快速把之前项目接口迁移过来？">Q2: 怎么快速把之前项目接口迁移过来？</a>
</li>
<li >
<a href="#Q3__忘记密码怎么办？">Q3: 忘记密码怎么办？</a>
</li>
</ul>
@ -160,7 +164,7 @@
<p>本页面罗列了大家使用 YApi 时遇到的常见问题.</p>
<p>如果没有找到您要的答案，请 qtalk 联系: <code>wenbo.dong; wenxiong.su; wenjie.zhang.</code></p>
<h2 class="subject" id="Q1__怎样联系组长？">Q1: 怎样联系组长？ <a class="hashlink" href="#Q1__怎样联系组长？">#</a></h2><p>A: 组长分为 <code>分组组长</code> 和 <code>项目组长</code>:</p>
<h2 class="subject" id="Q1__怎样联系组长？">Q1: 怎样联系组长？ <a class="hashlink" href="#Q1__怎样联系组长？">#</a></h2><p>组长分为 <code>分组组长</code> 和 <code>项目组长</code>:</p>
<ul>
<li>分组组长：选择首页左侧的分组，点击右侧面板的 <code>成员列表</code>，成员右侧显示着 <code>组长/开发者</code> 的权限信息。
<img src="./images/usage/manage_find_manager.png" /></li><li>项目组长: 点击项目页的 <code>设置</code> - <code>成员列表</code>，成员右侧显示着 <code>组长/开发者</code> 的权限信息。
@ -169,6 +173,7 @@
<p>第二步 录制当前项目所有请求，导出到har文件</p>
<p>第三步 将Har数据导入到YApi平台</p>
<p>具体使用方法请参考YApi<a href="./data.html#HAR%08%08_数据导入">文档</a></p>
<h2 class="subject" id="Q3__忘记密码怎么办？">Q3: 忘记密码怎么办？ <a class="hashlink" href="#Q3__忘记密码怎么办？">#</a></h2><p>请联系 <code>超级管理员</code> ，只有超级管理员能重置密码。</p>
</div>
</div>

5
static/doc/quickstart.html
View File

@ -167,8 +167,9 @@
<ul>
<li><a href="#获取权限">获取权限</a></li><li><a href="#选择项目">找到一个项目</a></li><li><a href="#新建接口">新建接口</a></li></ul>
<p>搞定~</p>
<h2 class="subject" id="获取权限">获取权限 <a class="hashlink" href="#获取权限">#</a></h2><p>新用户登录后没有任何项目或分组的权限，只能浏览已存在分组下面的公开项目。</p>
<p>如果找不到想找的项目，可能是未成为项目成员，此时应联系 <code>项目组长</code> 将你加入该项目。</p>
<h2 class="subject" id="获取权限">获取权限 <a class="hashlink" href="#获取权限">#</a></h2><p>新用户登录拥有 <code>个人空间</code> 分组下的全部权限，个人空间分组仅自己可见，因此可以在这里任意试用 YApi 的功能。</p>
<p>除此以外没有任何项目或分组的权限，只能浏览已存在分组下面的公开项目。</p>
<p>如果找不到想找的项目，可能是尚未成为项目成员，此时应联系 <code>项目组长</code> 将你加入该项目。</p>
<p><a href="./qa.html#Q__怎样联系组长？">怎样联系组长？</a></p>
<p><img src="./images/usage/manage_ask.png" /></p>
<ul>

4
static/doc/releases.html
View File

@ -89,7 +89,7 @@
<!-- <li > -->
<li >
<a href="#1.1">1.1</a>
<a href="#1.1.0">1.1.0</a>
</li>
<ul class="nav docs-sidenav-extend" >
@ -138,7 +138,7 @@
<div class="content-right markdown-body use-sidebar" role="main">
<h2 class="subject" id="1.1">1.1 <a class="hashlink" href="#1.1">#</a></h2><h3 class="subject" id="Features">Features <a class="hashlink" href="#Features">#</a></h3><ul>
<h2 class="subject" id="1.1.0">1.1.0 <a class="hashlink" href="#1.1.0">#</a></h2><h3 class="subject" id="Features">Features <a class="hashlink" href="#Features">#</a></h3><ul>
<li>新增个人空间功能，拥有这个分组的全部权限，可以在这个分组里探索 YApi 的功能</li><li>新增分组动态功能</li><li>优化接口运行页面交互</li><li>CrossRequest 扩展支持 https</li><li>增加了 Swagger 数据导入功能</li></ul>
<h2 class="subject" id="1.0.2">1.0.2 <a class="hashlink" href="#1.0.2">#</a></h2><h3 class="subject" id="Features">Features <a class="hashlink" href="#Features">#</a></h3><ul>
<li><p>网站改为100%布局</p>

8
static/doc/static/server/controllers/interface.js.html vendored
View File

@ -316,9 +316,11 @@ class interfaceController extends baseController {
desc: 'string',
catid: 'number'
});
params.method = params.method || 'GET';
params.method = params.method.toUpperCase();
if (!_.isUndefined(params.method)) {
params.method = params.method || 'GET';
params.method = params.method.toUpperCase();
}
let id = ctx.request.body.id;