docs: 文档修改

This commit is contained in:
wenbo.dong 2017-09-06 15:40:45 +08:00
commit 39b16e772c
17 changed files with 447 additions and 81 deletions

View File

@ -73,6 +73,8 @@
display: inline-block;
width: 180px;
overflow: hidden;
top: 0px;
line-height: 100%;
}
.interface-item-nav{
line-height:25px;
@ -85,7 +87,7 @@
.interface-delete-icon{
position: relative;
right: 21px;
top: 2px;
// top: 2px;
float: right;
line-height: 25px;
width: 30px;

31
doc/page/usage/manage.md Normal file
View File

@ -0,0 +1,31 @@
接口管理的逻辑较为复杂,操作频率高,层层审批将严重拖慢生产效率,因此传统的金字塔管理模式并不适用。
YAPI 将扁平化管理模式的思想引入到产品的权限管理中,`超级管理员` 拥有最高的权限,并将权限分配给若干 `组长``超级管理员` 只需管理`组长` 即可实际上管理YAPI各大分组与项目的是“`组长`”。`组长`对分组或项目负责一般由BU负责人/项目负责人担任。
## 认识组长
组长分为 `分组组长``项目组长`,组长对分组或项目负责,拥有分组或项目下的所有权限,二者区别如下:
`分组组长` 有权限修改分组、删除分组,可以创建分组下的项目。一般来说,组长只需要对项目负责,将项目的操作任务安排给项目组长处理即可。
`项目组长` 无法操作分组,但拥有项目的全部权限,`项目组长` 是 YApi 的基层管理者,承担了 YApi 绝大部分的日常管理工作。
## 权限列表
### 项目权限
| 操作 | 游客 | 开发者 | 组长 | 超级管理员 |
| :-------------- | :------------ | :------------ | :------------ | :------------ |
| 浏览项目与接口 | ✓ | ✓ | ✓ | ✓ |
| 编辑项目信息 | ✓ | ✓ | ✓ | ✓ |
### 分组权限
| 操作 | 开发者 | 项目组长 | 分组组长 | 超级管理员 |
| :-------------- | :------------ | :------------ | :------------ | :------------ |
| 浏览分组 |
| 编辑分组信息 |
| 在分组中新建项目 |
| 管理分组成员 |
| 删除分组 |

View File

@ -1,30 +1,3 @@
## 介绍
## 新建项目
接口管理的逻辑较为复杂,操作频率高,层层审批将严重拖慢生产效率,因此传统的金字塔管理模式并不适用。
YAPI 将扁平化管理模式的思想引入到产品的权限管理中,`超级管理员` 拥有最高的权限,并将权限分配给若干 `组长``超级管理员` 只需管理`组长` 即可实际上管理YAPI各大分组与项目的是“`组长`”。`组长`对分组或项目负责一般由BU负责人/项目负责人担任。
## 什么是组长?
组长分为分组组长与项目组长
## 安装 crossRequest chrome 插件
## 权限列表
### 项目权限
| 操作 | 游客 | 开发者 | 项目组长 | 分组组长 | 超级管理员 |
| :-------------- | :------------ | :------------ |
| 新建接口 | | ✓ | ✓ |
### 分组权限
| 操作 | 开发者 | 项目组长 | 分组组长 | 超级管理员 |
| :-------------- | :------------ | :------------ | :------------ | :------------ |
| 浏览分组 |
| 编辑分组信息 |
| 在分组中新建项目 |
| 管理分组成员 |
| 删除分组 |
## 修改项目

10
npm-shrinkwrap.json generated
View File

@ -8727,11 +8727,6 @@
"minimist": "0.0.8"
}
},
"mock": {
"version": "0.1.1",
"resolved": "https://repo.corp.qunar.com/artifactory/api/npm/npm-qunar/mock/-/mock-0.1.1.tgz",
"integrity": "sha1-5+NYnH5rM3bWn1o+RwtWYEQXxjM="
},
"mockjs": {
"version": "1.0.1-beta3",
"resolved": "https://repo.corp.qunar.com/artifactory/api/npm/npm-qunar/mockjs/-/mockjs-1.0.1-beta3.tgz",
@ -8745,11 +8740,6 @@
"resolved": "https://repo.corp.qunar.com/artifactory/api/npm/npm-qunar/moment/-/moment-2.18.1.tgz",
"integrity": "sha1-w2GT3Tzhwu7SrbfIAtu8d6gbHA8="
},
"monaco-editor": {
"version": "0.9.0",
"resolved": "https://repo.corp.qunar.com/artifactory/api/npm/npm-qunar/monaco-editor/-/monaco-editor-0.9.0.tgz",
"integrity": "sha1-xQxTJRxHt/8S4J8Pg8/TKkTf5uw="
},
"mongodb": {
"version": "2.2.27",
"resolved": "https://repo.corp.qunar.com/artifactory/api/npm/npm-qunar/mongodb/-/mongodb-2.2.27.tgz",

View File

@ -68,10 +68,8 @@
"koa-websocket": "^4.0.0",
"less": "^2.7.2",
"less-loader": "^4.0.5",
"mock": "^0.1.1",
"mockjs": "^1.0.1-beta3",
"moment": "^2.18.1",
"monaco-editor": "^0.9.0",
"mongoose": "4.10.8",
"mongoose-auto-increment": "^5.0.1",
"node-sass": "^4.5.3",

View File

@ -1,19 +1,19 @@
{
"_from": "yapi-plugin-qsso@1.0.5",
"_from": "yapi-plugin-qsso@^1.0.2",
"_id": "yapi-plugin-qsso@1.0.5",
"_inBundle": false,
"_integrity": "sha512-1Sy2zY4FUeMr4BoGAVLyaQeNizTiOl5enPOeJUlHPDTqawP9loBBdfUdHg89OLPJai/g0OD3kncTH2+sNPu5/g==",
"_location": "/yapi-plugin-qsso",
"_phantomChildren": {},
"_requested": {
"type": "version",
"type": "range",
"registry": true,
"raw": "yapi-plugin-qsso@1.0.5",
"raw": "yapi-plugin-qsso@^1.0.2",
"name": "yapi-plugin-qsso",
"escapedName": "yapi-plugin-qsso",
"rawSpec": "1.0.5",
"rawSpec": "^1.0.2",
"saveSpec": null,
"fetchSpec": "1.0.5"
"fetchSpec": "^1.0.2"
},
"_requiredBy": [
"#USER",
@ -21,8 +21,8 @@
],
"_resolved": "https://registry.npmjs.org/yapi-plugin-qsso/-/yapi-plugin-qsso-1.0.5.tgz",
"_shasum": "c9da87bdd7a378e601d38fc8fcce965f4337d27e",
"_spec": "yapi-plugin-qsso@1.0.5",
"_where": "/Users/sean/qunar/yapi",
"_spec": "yapi-plugin-qsso@^1.0.2",
"_where": "/Users/qitmac000249/Downloads/yapi_project",
"author": "",
"bugs": {
"url": "https://github.com/YMFE/yapi-plugin-qsso/issues"

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -91,13 +91,19 @@
<!-- <li > -->
<li >
<a href="usage-项目管理.html">项目管理</a>
<a href="usage-管理分组与项目.html">管理分组与项目</a>
</li>
<!-- <li > -->
<li >
<a href="usage-接口配置与调试.html">接口配置与调试</a>
<a href="usage-项目操作.html">项目操作</a>
</li>
<!-- <li > -->
<li >
<a href="usage-接口操作.html">接口操作</a>
</li>
<!-- <li class="active" class="active" > -->

View File

@ -91,13 +91,19 @@
<!-- <li > -->
<li >
<a href="usage-项目管理.html">项目管理</a>
<a href="usage-管理分组与项目.html">管理分组与项目</a>
</li>
<!-- <li > -->
<li >
<a href="usage-接口配置与调试.html">接口配置与调试</a>
<a href="usage-项目操作.html">项目操作</a>
</li>
<!-- <li > -->
<li >
<a href="usage-接口操作.html">接口操作</a>
</li>
<!-- <li > -->

View File

@ -107,13 +107,19 @@
<!-- <li > -->
<li >
<a href="usage-项目管理.html">项目管理</a>
<a href="usage-管理分组与项目.html">管理分组与项目</a>
</li>
<!-- <li > -->
<li >
<a href="usage-接口配置与调试.html">接口配置与调试</a>
<a href="usage-项目操作.html">项目操作</a>
</li>
<!-- <li > -->
<li >
<a href="usage-接口操作.html">接口操作</a>
</li>
<!-- <li > -->

View File

@ -91,13 +91,19 @@
<!-- <li > -->
<li >
<a href="usage-项目管理.html">项目管理</a>
<a href="usage-管理分组与项目.html">管理分组与项目</a>
</li>
<!-- <li > -->
<li >
<a href="usage-项目操作.html">项目操作</a>
</li>
<!-- <li class="active" class="active" > -->
<li class="active" >
<a href="usage-接口配置与调试.html">接口配置与调试</a>
<a href="usage-接口操作.html">接口操作</a>
</li>
<ul class="nav docs-sidenav-extend" >

View File

@ -91,21 +91,13 @@
<!-- <li class="active" class="active" > -->
<li class="active" >
<a href="usage-项目管理.html">项目管理</a>
<a href="usage-管理分组与项目.html">管理分组与项目</a>
</li>
<ul class="nav docs-sidenav-extend" >
<li >
<a href="#介绍">介绍</a>
</li>
<li >
<a href="#组长职责">组长职责</a>
</li>
<li >
<a href="#安装_crossRequest_chrome_插件">安装 crossRequest chrome 插件</a>
<a href="#认识组长">认识组长</a>
</li>
<li >
@ -117,7 +109,13 @@
<!-- <li > -->
<li >
<a href="usage-接口配置与调试.html">接口配置与调试</a>
<a href="usage-项目操作.html">项目操作</a>
</li>
<!-- <li > -->
<li >
<a href="usage-接口操作.html">接口操作</a>
</li>
<!-- <li > -->
@ -138,22 +136,27 @@
<div class="content-right markdown-body use-sidebar" role="main">
<h2 class="subject" id="介绍">介绍 <a class="hashlink" href="#介绍">#</a></h2><h2 class="subject" id="组长职责">组长职责 <a class="hashlink" href="#组长职责">#</a></h2><h2 class="subject" id="安装_crossRequest_chrome_插件">安装 crossRequest chrome 插件 <a class="hashlink" href="#安装_crossRequest_chrome_插件">#</a></h2><h2 class="subject" id="权限列表">权限列表 <a class="hashlink" href="#权限列表">#</a></h2><h3 class="subject" id="项目权限">项目权限 <a class="hashlink" href="#项目权限">#</a></h3><table>
<p>接口管理的逻辑较为复杂,操作频率高,层层审批将严重拖慢生产效率,因此传统的金字塔管理模式并不适用。</p>
<p>YAPI 将扁平化管理模式的思想引入到产品的权限管理中,<code>超级管理员</code> 拥有最高的权限,并将权限分配给若干 <code>组长</code><code>超级管理员</code> 只需管理<code>组长</code> 即可实际上管理YAPI各大分组与项目的是“<code>组长</code>”。<code>组长</code>对分组或项目负责一般由BU负责人/项目负责人担任。</p>
<h2 class="subject" id="认识组长">认识组长 <a class="hashlink" href="#认识组长">#</a></h2><p>组长分为 <code>分组组长</code><code>项目组长</code>,组长对分组或项目负责,拥有分组或项目下的所有权限,二者区别如下:</p>
<p><code>分组组长</code> 有权限修改分组、删除分组,可以创建分组下的项目。一般来说,组长只需要对项目负责,将项目的操作任务安排给项目组长处理即可。</p>
<p><code>项目组长</code> 无法操作分组,但拥有项目的全部权限,<code>项目组长</code> 是 YApi 的基层管理者,承担了 YApi 绝大部分的日常管理工作。</p>
<h2 class="subject" id="权限列表">权限列表 <a class="hashlink" href="#权限列表">#</a></h2><h3 class="subject" id="项目权限">项目权限 <a class="hashlink" href="#项目权限">#</a></h3><table>
<thead>
<tr>
<th style="text-align:left">操作</th>
<th style="text-align:left">游客</th>
<th style="text-align:left">开发者</th>
<th style="text-align:left">项目组长</th>
<th>分组组长</th>
<th>超级管理员</th>
<th style="text-align:left">组长</th>
<th style="text-align:left">超级管理员</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">新建项目</td>
<td style="text-align:left">浏览项目</td>
<td style="text-align:left"></td>
<td style="text-align:left"></td>
<td></td>
<td style="text-align:left"></td>
</tr>
</tbody>
</table>
@ -164,7 +167,7 @@
<th style="text-align:left">开发者</th>
<th style="text-align:left">项目组长</th>
<th style="text-align:left">分组组长</th>
<th>超级管理员</th>
<th style="text-align:left">超级管理员</th>
</tr>
</thead>
<tbody>

View File

@ -111,13 +111,19 @@
<!-- <li > -->
<li >
<a href="usage-项目管理.html">项目管理</a>
<a href="usage-管理分组与项目.html">管理分组与项目</a>
</li>
<!-- <li > -->
<li >
<a href="usage-接口配置与调试.html">接口配置与调试</a>
<a href="usage-项目操作.html">项目操作</a>
</li>
<!-- <li > -->
<li >
<a href="usage-接口操作.html">接口操作</a>
</li>
<!-- <li > -->

View File

@ -0,0 +1,206 @@
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" />
<meta name="format-detection" content="telephone=no,email=no" />
<meta http-equiv="X-UA-Compatible" content="ie=edge, chrome=1">
<meta name="description" content="description of your site">
<meta name="author" content="author of the site">
<title>YApi 使用手册</title>
<link rel="stylesheet" href="source/main.css" />
<link rel="stylesheet" href="styles/theme.css" />
</head>
<body>
<div class="ydoc">
<header class="ydoc-header">
<div class="ydoc-header-area">
<a href="http://ued.qunar.com/ymfe/" class="navbar-brand">YMFE</a>
<button class="ydocIcon navbar-toggle">&#xf020;</button>
<nav class="ydoc-nav">
<ul class="navbar-left">
<li class="">
<a href="index.html">首页</a>
</li>
<li class="active">
<a href="usage.html">使用手册</a>
</li>
<li class="">
<a href="manage.html">管理学院</a>
</li>
<li class="">
<a href="api.html"></a>
</li>
</ul>
</nav>
</div>
</header>
<!-- <header style="height:20px"></header> -->
<!-- Docs page layout -->
<div class="ydoc-banner-bg">
<div class="ydoc-banner ">
<div class="ydoc-banner-area">
<h1 >YApi</h1>
<p class="desc ">高效、易用、功能强大的api管理平台旨在为开发、产品、测试人员提供更优雅的接口管理服务。</p>
</div>
</div>
<div class="ydoc-container">
<div class="ydoc-container-content ">
<div class="content-left staticsidenav" role="complementary">
<nav class="docs-sidebar hidden-print hidden-xs hidden-sm">
<ul class="nav docs-sidenav">
<!-- <li > -->
<li >
<a href="usage-认识 YApi.html">认识 YApi</a>
</li>
<!-- <li > -->
<li >
<a href="usage-创建第一个API.html">创建第一个API</a>
</li>
<!-- <li > -->
<li >
<a href="usage-管理分组与项目.html">管理分组与项目</a>
</li>
<!-- <li class="active" class="active" > -->
<li class="active" >
<a href="usage-项目操作.html">项目操作</a>
</li>
<ul class="nav docs-sidenav-extend" >
<li >
<a href="#新建项目">新建项目</a>
</li>
<li >
<a href="#修改项目">修改项目</a>
</li>
</ul>
<!-- <li > -->
<li >
<a href="usage-接口操作.html">接口操作</a>
</li>
<!-- <li > -->
<li >
<a href="usage-使用mock功能.html">使用mock功能</a>
</li>
<!-- <li > -->
<li >
<a href="usage-使用测试集.html">使用测试集</a>
</li>
</ul>
</nav>
</div>
<div class="content-right markdown-body use-sidebar" role="main">
<h2 class="subject" id="新建项目">新建项目 <a class="hashlink" href="#新建项目">#</a></h2><h2 class="subject" id="修改项目">修改项目 <a class="hashlink" href="#修改项目">#</a></h2>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="copyright">
&copy; 2016 <a href="http://ued.qunar.com/ymfe/">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>.
</div>
</footer>
</div>
<div class="open-panel"></div>
<div class="mask"></div>
<script src="source/main.js"></script>
<script src="source/app.js"></script>
<script>
var lineHeight = 18;
var EXAMPLE_MAX_HEIGHT;
function fold() {
// 折叠code
$('.markdown-body pre').css({
"line-height": lineHeight + "px"
});
$('.markdown-body pre').map(function(i, item) {
var $item = $(item);
var foldnumber = $item.data('foldnumber');
EXAMPLE_MAX_HEIGHT = lineHeight * (foldnumber || 6);
if ($item.height() > EXAMPLE_MAX_HEIGHT) {
$item.css({
"padding-bottom": 30
});
$item.find('code').height(EXAMPLE_MAX_HEIGHT);
$item.append('<span class="extend">展开更多……</span>');
};
});
$('.ydoc-example').delegate('.extend', 'click', function() {
var $this = $(this);
$this.removeClass('extend').addClass('fold');
$this.html('折叠代码');
$this.parent().children('.js-code').height('auto');
$this.parent().height('auto');
});
$('.ydoc-example').delegate('.fold', 'click', function() {
var $this = $(this);
var foldnumber = $this.parent().data('foldnumber');
EXAMPLE_MAX_HEIGHT = lineHeight * (foldnumber || 6);
$this.removeClass('fold').addClass('extend');
$this.parent().height(EXAMPLE_MAX_HEIGHT); // pre
$this.parent().children('.js-code').height(EXAMPLE_MAX_HEIGHT); // code
$this.html("展开更多……");
});
}
$(document).ready(fold);
</script>
</body>
</html>

View File

@ -91,13 +91,19 @@
<!-- <li > -->
<li >
<a href="usage-项目管理.html">项目管理</a>
<a href="usage-管理分组与项目.html">管理分组与项目</a>
</li>
<!-- <li > -->
<li >
<a href="usage-接口配置与调试.html">接口配置与调试</a>
<a href="usage-项目操作.html">项目操作</a>
</li>
<!-- <li > -->
<li >
<a href="usage-接口操作.html">接口操作</a>
</li>
<!-- <li > -->

View File

@ -75,10 +75,13 @@
"name": "创建第一个API",
"content": "./doc/page/usage/quickstart.md"
},{
"name": "项目管理",
"name": "管理分组与项目",
"content": "./doc/page/usage/manage.md"
},{
"name": "项目操作",
"content": "./doc/page/usage/project.md"
},{
"name": "接口配置与调试",
"name": "接口操作",
"content": "./doc/page/usage/api.md"
},{
"name": "使用mock功能",