mirror of
https://github.com/YMFE/yapi.git
synced 2024-12-21 05:19:42 +08:00
docs: 完成 认识YApi 的文档
This commit is contained in:
wenbo.dong
parent
68c4450013
commit
956a3c4f29
Binary file not shown.
|
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 69 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 106 KiB After Width: | Height: | Size: 85 KiB |
@ -13,3 +13,18 @@ body, h1, h2, h3, h4, h5, h6 {
|
||||
display: block;
|
||||
margin: 24px 0;
|
||||
}
|
||||
|
||||
.list-index {
|
||||
padding: 6px;
|
||||
background-color: #ff561b;
|
||||
color: #fff;
|
||||
font:italic bold 18px arial,sans-serif;
|
||||
border-radius: 50%;
|
||||
display: inline-block;
|
||||
width: 2.2em;
|
||||
height: 2.2em;
|
||||
line-height: 1.6em;
|
||||
margin-right: .6em;
|
||||
text-align: center;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
@ -5,6 +5,7 @@ YApi 是高效、易用、功能强大的api管理平台。
|
||||
|
||||
## 登录与注册
|
||||
想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。
|
||||
|
||||
<img src="./images/usage/login.png" />
|
||||
|
||||
## 首页
|
||||
@ -13,13 +14,13 @@ YApi 是高效、易用、功能强大的api管理平台。
|
||||
|
||||
此时你作为新用户，没有任何分组与项目的权限，因此只能搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。
|
||||
|
||||
1.首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。
|
||||
<span class="list-index">1</span>首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。
|
||||
|
||||
2.首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。
|
||||
<span class="list-index">2</span>首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。
|
||||
|
||||
3.首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。
|
||||
<span class="list-index">3</span>首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。
|
||||
|
||||
4.点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。
|
||||
<span class="list-index">4</span>点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。
|
||||
|
||||
<img src="./images/usage/index.png" />
|
||||
|
||||
@ -29,15 +30,15 @@ YApi 是高效、易用、功能强大的api管理平台。
|
||||
|
||||
此时你作为新用户，只能浏览接口信息，不可以编辑项目或接口，如果需要编辑，请联系管理员将你加入该项目。
|
||||
|
||||
1.项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。
|
||||
<span class="list-index">1</span>项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。
|
||||
|
||||
2.点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。
|
||||
<span class="list-index">2</span>点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。
|
||||
|
||||
3.点击左侧的 “测试集合” 使用[./case.html](测试集)功能。
|
||||
<span class="list-index">3</span>点击左侧的 “测试集合” 使用[测试集](./case.html)功能。
|
||||
|
||||
4.点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。
|
||||
<span class="list-index">4</span>点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。
|
||||
|
||||
5.点击二级导航的“动态”，即可查看项目的操作日志。
|
||||
<span class="list-index">5</span>点击二级导航的“动态”，即可查看项目的操作日志。
|
||||
|
||||
<img src="./images/usage/project.png" />
|
||||
|
||||
|
||||
@ -3875,7 +3875,7 @@
|
||||
|
||||
<p>
|
||||
<small class="text-muted">源码位置:</small>
|
||||
<a href="./static/server/controllers/interface.js.html#423" target="_blank">./server/controllers/interface.js:423</a>
|
||||
<a href="./static/server/controllers/interface.js.html#425" target="_blank">./server/controllers/interface.js:425</a>
|
||||
</p>
|
||||
|
||||
|
||||
@ -4804,7 +4804,7 @@
|
||||
|
||||
<p>
|
||||
<small class="text-muted">源码位置:</small>
|
||||
<a href="./static/server/controllers/interfaceCol.js.html#329" target="_blank">./server/controllers/interfaceCol.js:329</a>
|
||||
<a href="./static/server/controllers/interfaceCol.js.html#330" target="_blank">./server/controllers/interfaceCol.js:330</a>
|
||||
</p>
|
||||
|
||||
|
||||
@ -4878,7 +4878,7 @@
|
||||
|
||||
<p>
|
||||
<small class="text-muted">源码位置:</small>
|
||||
<a href="./static/server/controllers/interfaceCol.js.html#370" target="_blank">./server/controllers/interfaceCol.js:370</a>
|
||||
<a href="./static/server/controllers/interfaceCol.js.html#371" target="_blank">./server/controllers/interfaceCol.js:371</a>
|
||||
</p>
|
||||
|
||||
|
||||
@ -4938,7 +4938,7 @@
|
||||
|
||||
<p>
|
||||
<small class="text-muted">源码位置:</small>
|
||||
<a href="./static/server/controllers/interfaceCol.js.html#412" target="_blank">./server/controllers/interfaceCol.js:412</a>
|
||||
<a href="./static/server/controllers/interfaceCol.js.html#413" target="_blank">./server/controllers/interfaceCol.js:413</a>
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 69 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 106 KiB After Width: | Height: | Size: 85 KiB |
@ -164,7 +164,6 @@ class interfaceController extends baseController {
|
||||
|
||||
let result = await this.Model.save(data);
|
||||
|
||||
let project = await this.projectModel.getBaseInfo(params.project_id);
|
||||
this.catModel.get(params.catid).then((cate) => {
|
||||
let username = this.getUsername();
|
||||
let title = `用户 "${username}" 为分类 "${cate.name}" 添加了接口 "${data.title}"`
|
||||
@ -175,15 +174,16 @@ class interfaceController extends baseController {
|
||||
username: username,
|
||||
typeid: params.project_id
|
||||
});
|
||||
let interfaceUrl = `http://${ctx.request.host}/project/${params.project_id}/interface/api/${result._id}`
|
||||
this.sendNotice(params.project_id, {
|
||||
title: `${username} 新增了接口 ${data.title}`,
|
||||
content: `<div><h3>${username}新增了接口(${data.title})</h3>
|
||||
<p>项目名：${project.name}</p>
|
||||
<p>修改用户: "${username}"</p>
|
||||
<p>接口名: <a href="${interfaceUrl}">${data.title}</a></p>
|
||||
<p>接口路径: [${data.method}]${data.path}</p></div>`
|
||||
})
|
||||
//let project = await this.projectModel.getBaseInfo(params.project_id);
|
||||
// let interfaceUrl = `http://${ctx.request.host}/project/${params.project_id}/interface/api/${result._id}`
|
||||
// this.sendNotice(params.project_id, {
|
||||
// title: `${username} 新增了接口 ${data.title}`,
|
||||
// content: `<div><h3>${username}新增了接口(${data.title})</h3>
|
||||
// <p>项目名：${project.name}</p>
|
||||
// <p>修改用户: "${username}"</p>
|
||||
// <p>接口名: <a href="${interfaceUrl}">${data.title}</a></p>
|
||||
// <p>接口路径: [${data.method}]${data.path}</p></div>`
|
||||
// })
|
||||
});
|
||||
|
||||
ctx.body = yapi.commons.resReturn(result);
|
||||
@ -321,7 +321,7 @@ class interfaceController extends baseController {
|
||||
|
||||
let id = ctx.request.body.id;
|
||||
|
||||
params.message = params.message || '没有改动日志';
|
||||
params.message = params.message || '';
|
||||
params.message = params.message.replace(/\n/g, "<br>")
|
||||
|
||||
if (!id) {
|
||||
@ -429,17 +429,19 @@ class interfaceController extends baseController {
|
||||
});
|
||||
});
|
||||
}
|
||||
let project = await this.projectModel.getBaseInfo(interfaceData.project_id);
|
||||
let interfaceUrl = `http://${ctx.request.host}/project/${interfaceData.project_id}/interface/api/${id}`
|
||||
this.sendNotice(interfaceData.project_id, {
|
||||
title: `${username} 更新了接口`,
|
||||
content: `<div><h3>${username}更新了接口(${data.title})</h3>
|
||||
<p>项目名：${project.name} </p>
|
||||
<p>修改用户: ${username}</p>
|
||||
<p>接口名: <a href="${interfaceUrl}">${data.title}</a></p>
|
||||
<p>接口路径: [${data.method}]${data.path}</p>
|
||||
<p>详细改动日志: ${params.message}</p></div>`
|
||||
})
|
||||
if (params.switch_notice === true) {
|
||||
let project = await this.projectModel.getBaseInfo(interfaceData.project_id);
|
||||
let interfaceUrl = `http://${ctx.request.host}/project/${interfaceData.project_id}/interface/api/${id}`
|
||||
this.sendNotice(interfaceData.project_id, {
|
||||
title: `${username} 更新了接口`,
|
||||
content: `<div><h3>${username}更新了接口(${data.title})</h3>
|
||||
<p>项目名：${project.name} </p>
|
||||
<p>修改用户: ${username}</p>
|
||||
<p>接口名: <a href="${interfaceUrl}">${data.title}</a></p>
|
||||
<p>接口路径: [${data.method}]${data.path}</p>
|
||||
<p>详细改动日志: ${params.message}</p></div>`
|
||||
})
|
||||
}
|
||||
|
||||
ctx.body = yapi.commons.resReturn(result);
|
||||
} catch (e) {
|
||||
|
||||
@ -328,12 +328,13 @@ class interfaceColController extends baseController{
|
||||
result.method = data.method;
|
||||
result.req_body_type = data.req_body_type;
|
||||
result.req_headers = data.req_headers;
|
||||
|
||||
result.res_body = data.res_body;
|
||||
result.res_body_type = data.res_body_type;
|
||||
|
||||
result.req_body_form = this.handleParamsValue(data.req_body_form, result.req_body_form)
|
||||
result.req_query = this.handleParamsValue(data.req_query, result.req_query)
|
||||
result.req_params = this.handleParamsValue(data.req_params, result.req_params)
|
||||
|
||||
|
||||
ctx.body = yapi.commons.resReturn(result);
|
||||
}catch(e){
|
||||
ctx.body = yapi.commons.resReturn(null, 400, e.message)
|
||||
|
||||
@ -13,3 +13,18 @@ body, h1, h2, h3, h4, h5, h6 {
|
||||
display: block;
|
||||
margin: 24px 0;
|
||||
}
|
||||
|
||||
.list-index {
|
||||
padding: 6px;
|
||||
background-color: #ff561b;
|
||||
color: #fff;
|
||||
font:italic bold 18px arial,sans-serif;
|
||||
border-radius: 50%;
|
||||
display: inline-block;
|
||||
width: 2.2em;
|
||||
height: 2.2em;
|
||||
line-height: 1.6em;
|
||||
margin-right: .6em;
|
||||
text-align: center;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
@ -142,22 +142,22 @@
|
||||
<p>YApi 是高效、易用、功能强大的api管理平台。
|
||||
<!-- 它有扁平化的管理结构(`超管`-`组长`-`组员`)，有清晰的接口组织方式(`分组`-`项目`-`接口`)，有更方便的mock方案。 --></p>
|
||||
<p>在开始使用 YApi 之前，我们先来熟悉一下 YApi 的网站结构，这将让你快速了解YApi。</p>
|
||||
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。
|
||||
<img src="./images/usage/login.png" /></p>
|
||||
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。</p>
|
||||
<p><img src="./images/usage/login.png" /></p>
|
||||
<h2 class="subject" id="首页">首页 <a class="hashlink" href="#首页">#</a></h2><p>登录后进入首页，首页展示了分组与项目。</p>
|
||||
<p>此时你作为新用户，没有任何分组与项目的权限，因此只能搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。</p>
|
||||
<p>1.首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。</p>
|
||||
<p>2.首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。</p>
|
||||
<p>3.首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。</p>
|
||||
<p>4.点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。</p>
|
||||
<p><span class="list-index">1</span>首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。</p>
|
||||
<p><span class="list-index">2</span>首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。</p>
|
||||
<p><span class="list-index">3</span>首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。</p>
|
||||
<p><span class="list-index">4</span>点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。</p>
|
||||
<p><img src="./images/usage/index.png" /></p>
|
||||
<h2 class="subject" id="项目页">项目页 <a class="hashlink" href="#项目页">#</a></h2><p>点击一个项目，进入项目页，项目页展示了属于该项目的全部接口，并提供项目、接口的全部操作。</p>
|
||||
<p>此时你作为新用户，只能浏览接口信息，不可以编辑项目或接口，如果需要编辑，请联系管理员将你加入该项目。</p>
|
||||
<p>1.项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。</p>
|
||||
<p>2.点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。</p>
|
||||
<p>3.点击左侧的 “测试集合” 使用<a href="测试集">./case.html</a>功能。</p>
|
||||
<p>4.点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。</p>
|
||||
<p>5.点击二级导航的“动态”，即可查看项目的操作日志。</p>
|
||||
<p><span class="list-index">1</span>项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。</p>
|
||||
<p><span class="list-index">2</span>点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。</p>
|
||||
<p><span class="list-index">3</span>点击左侧的 “测试集合” 使用<a href="./case.html">测试集</a>功能。</p>
|
||||
<p><span class="list-index">4</span>点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。</p>
|
||||
<p><span class="list-index">5</span>点击二级导航的“动态”，即可查看项目的操作日志。</p>
|
||||
<p><img src="./images/usage/project.png" /></p>
|
||||
<h2 class="subject" id="个人中心">个人中心 <a class="hashlink" href="#个人中心">#</a></h2><p>鼠标移动到右上角的用户头像或用户名上，即可点击“个人中心”查看个人信息。</p>
|
||||
<p><img src="./images/usage/hover.png" /></p>
|
||||
|
||||
@ -122,22 +122,22 @@
|
||||
<p>YApi 是高效、易用、功能强大的api管理平台。
|
||||
<!-- 它有扁平化的管理结构(`超管`-`组长`-`组员`)，有清晰的接口组织方式(`分组`-`项目`-`接口`)，有更方便的mock方案。 --></p>
|
||||
<p>在开始使用 YApi 之前，我们先来熟悉一下 YApi 的网站结构，这将让你快速了解YApi。</p>
|
||||
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。
|
||||
<img src="./images/usage/login.png" /></p>
|
||||
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。</p>
|
||||
<p><img src="./images/usage/login.png" /></p>
|
||||
<h2 class="subject" id="首页">首页 <a class="hashlink" href="#首页">#</a></h2><p>登录后进入首页，首页展示了分组与项目。</p>
|
||||
<p>此时你作为新用户，没有任何分组与项目的权限，因此只能搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。</p>
|
||||
<p>1.首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。</p>
|
||||
<p>2.首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。</p>
|
||||
<p>3.首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。</p>
|
||||
<p>4.点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。</p>
|
||||
<p><span class="list-index">1</span>首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。</p>
|
||||
<p><span class="list-index">2</span>首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。</p>
|
||||
<p><span class="list-index">3</span>首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。</p>
|
||||
<p><span class="list-index">4</span>点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。</p>
|
||||
<p><img src="./images/usage/index.png" /></p>
|
||||
<h2 class="subject" id="项目页">项目页 <a class="hashlink" href="#项目页">#</a></h2><p>点击一个项目，进入项目页，项目页展示了属于该项目的全部接口，并提供项目、接口的全部操作。</p>
|
||||
<p>此时你作为新用户，只能浏览接口信息，不可以编辑项目或接口，如果需要编辑，请联系管理员将你加入该项目。</p>
|
||||
<p>1.项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。</p>
|
||||
<p>2.点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。</p>
|
||||
<p>3.点击左侧的 “测试集合” 使用<a href="测试集">./case.html</a>功能。</p>
|
||||
<p>4.点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。</p>
|
||||
<p>5.点击二级导航的“动态”，即可查看项目的操作日志。</p>
|
||||
<p><span class="list-index">1</span>项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。</p>
|
||||
<p><span class="list-index">2</span>点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。</p>
|
||||
<p><span class="list-index">3</span>点击左侧的 “测试集合” 使用<a href="./case.html">测试集</a>功能。</p>
|
||||
<p><span class="list-index">4</span>点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。</p>
|
||||
<p><span class="list-index">5</span>点击二级导航的“动态”，即可查看项目的操作日志。</p>
|
||||
<p><img src="./images/usage/project.png" /></p>
|
||||
<h2 class="subject" id="个人中心">个人中心 <a class="hashlink" href="#个人中心">#</a></h2><p>鼠标移动到右上角的用户头像或用户名上，即可点击“个人中心”查看个人信息。</p>
|
||||
<p><img src="./images/usage/hover.png" /></p>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user