mirror of
https://github.com/YMFE/yapi.git
synced 2025-01-06 12:45:22 +08:00
docs: 优化文档
This commit is contained in:
wenbo.dong
parent
ce58872b0e
commit
f226b83e5d
BIN
doc/images/usage/manage_ask.png
Normal file
BIN
doc/images/usage/manage_ask.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 92 KiB |
BIN
doc/images/usage/manage_ask_group.png
Normal file
BIN
doc/images/usage/manage_ask_group.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 92 KiB |
BIN
doc/images/usage/manage_find_manager.png
Normal file
BIN
doc/images/usage/manage_find_manager.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
BIN
doc/images/usage/manage_find_project_owner.png
Normal file
BIN
doc/images/usage/manage_find_project_owner.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
@ -10,13 +10,24 @@ YApi 将扁平化管理模式的思想引入到产品的权限管理中，`超
|
||||
|
||||
`项目组长` 无法操作分组，但拥有项目的全部权限，`项目组长` 是 YApi 的基层管理者，承担了 YApi 绝大部分的日常管理工作。
|
||||
|
||||
### 如何成为组长？
|
||||
## 创建分组
|
||||
只有 `超级管理员` 有权限创建分组
|
||||
|
||||
> - 联系超级管理员，说明要创建的分组名称和自己的用户名。
|
||||
- 联系超级管理员`(Qtalk: wenbo.dong; wenxiong.su; wenjie.zhang.)`，说明要创建的分组名称和自己的用户名。
|
||||
- 分组一般以 BU 作为维度。
|
||||
|
||||
## 创建项目
|
||||
只有 `分组组长` 和 `超级管理员` 有权限创建项目。
|
||||
|
||||
<img src="./images/usage/manage_ask_group.png" />
|
||||
|
||||
- 想成为 `分组组长` ，在分组成员列表中找到 `分组组长`，联系 `分组组长` 将你设置为分组组长。
|
||||
|
||||
[怎样联系组长？](./index-常见问题.html#Q__怎样联系组长？)
|
||||
|
||||
## 权限列表
|
||||
|
||||
新用户未加入项目或分组时，是 `“游客”`
|
||||
新用户未加入项目或分组时，我们称为 `“游客”`。
|
||||
|
||||
### 项目权限
|
||||
|
||||
|
||||
11
doc/page/usage/qa.md
Normal file
11
doc/page/usage/qa.md
Normal file
@ -0,0 +1,11 @@
|
||||
本页面罗列了大家使用 YApi 时遇到的常见问题.
|
||||
|
||||
如果没有找到您要的答案，请 qtalk 联系: `wenbo.dong; wenxiong.su; wenjie.zhang.`
|
||||
|
||||
## Q: 怎样联系组长？
|
||||
|
||||
A: 组长分为 `分组组长` 和 `项目组长`:
|
||||
- 分组组长：选择首页左侧的分组，点击右侧面板的 `成员列表`，成员右侧显示着 `组长/开发者` 的权限信息。
|
||||
<img src="./images/usage/manage_find_manager.png" />
|
||||
- 项目组长: 点击项目页的 `设置` - `成员列表`，成员右侧显示着 `组长/开发者` 的权限信息。
|
||||
<img src="./images/usage/manage_find_project_owner.png" />
|
||||
@ -1,4 +1,4 @@
|
||||
### 如何创建项目？
|
||||
### 如何创建接口？
|
||||
|
||||
把大象装进冰箱分几步？三步：把冰箱门打开，把大象装进去，关门，搞定~
|
||||
|
||||
@ -13,8 +13,18 @@
|
||||
|
||||
## 获取权限
|
||||
|
||||
- 登录后查看项目，如果找不到对应分组或项目，需要联系组长获取项目权限。
|
||||
新用户登录后没有任何项目或分组的权限，只能浏览已存在分组下面的公开项目。
|
||||
|
||||
如果找不到想找的项目，可能是未成为项目成员，此时应联系 `项目组长` 将你加入该项目。
|
||||
|
||||
[怎样联系组长？](./index-常见问题.html#Q__怎样联系组长？)
|
||||
|
||||
<img src="./images/usage/manage_ask.png" />
|
||||
|
||||
- 想创建分组，请看: [创建分组](./index-管理分组与项目.html#创建分组)
|
||||
- 想创建项目，请看: [创建项目](./index-管理分组与项目.html#创建项目)
|
||||
|
||||
> 想了解更多权限信息，请查看[权限列表](./index-管理分组与项目.html#权限列表)
|
||||
|
||||
## 选择项目
|
||||
|
||||
@ -22,8 +32,6 @@
|
||||
|
||||
- 点击一个项目，进入该项目的详情页。
|
||||
|
||||
> 如果没有找到项目，请联系组长
|
||||
|
||||
<img src="./images/project_list.png" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center />
|
||||
|
||||
## 新建接口
|
||||
@ -36,8 +44,6 @@
|
||||
|
||||
<img src="./images/usage/api_add_panel.png" />
|
||||
|
||||
> 如果没有新建项目权限，请联系组长
|
||||
|
||||
- 恭喜你！创建了第一个YApi的接口，你可以看到在左侧看到接口名称，右侧有该接口的信息预览。
|
||||
|
||||
<img src="./images/usage/api_res.png" />
|
||||
|
||||
BIN
static/doc/images/usage/manage_ask.png
Normal file
BIN
static/doc/images/usage/manage_ask.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 92 KiB |
BIN
static/doc/images/usage/manage_ask_group.png
Normal file
BIN
static/doc/images/usage/manage_ask_group.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 92 KiB |
BIN
static/doc/images/usage/manage_find_manager.png
Normal file
BIN
static/doc/images/usage/manage_find_manager.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
BIN
static/doc/images/usage/manage_find_project_owner.png
Normal file
BIN
static/doc/images/usage/manage_find_project_owner.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
@ -131,6 +131,12 @@
|
||||
|
||||
<a href="index-使用测试集.html">使用测试集</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-常见问题.html">常见问题</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@ -125,9 +125,15 @@
|
||||
<li >
|
||||
<a href="#查看接口用例">查看接口用例</a>
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-常见问题.html">常见问题</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
@ -123,6 +123,12 @@
|
||||
|
||||
<a href="index-使用测试集.html">使用测试集</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-常见问题.html">常见问题</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@ -130,20 +136,24 @@
|
||||
|
||||
<div class="content-right markdown-body use-sidebar" role="main">
|
||||
|
||||
<h3 class="subject" id="如何创建项目？">如何创建项目？ <a class="hashlink" href="#如何创建项目？">#</a></h3><p>把大象装进冰箱分几步？三步：把冰箱门打开，把大象装进去，关门，搞定~</p>
|
||||
<h3 class="subject" id="如何创建接口？">如何创建接口？ <a class="hashlink" href="#如何创建接口？">#</a></h3><p>把大象装进冰箱分几步？三步：把冰箱门打开，把大象装进去，关门，搞定~</p>
|
||||
<p>新建接口分几步？也是三步：</p>
|
||||
<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><ul>
|
||||
<li>登录后查看项目，如果找不到对应分组或项目，需要联系组长获取项目权限。</li></ul>
|
||||
<h2 class="subject" id="获取权限">获取权限 <a class="hashlink" href="#获取权限">#</a></h2><p>新用户登录后没有任何项目或分组的权限，只能浏览已存在分组下面的公开项目。</p>
|
||||
<p>如果找不到想找的项目，可能是未成为项目成员，此时应联系 <code>项目组长</code> 将你加入该项目。</p>
|
||||
<p><a href="./index-常见问题.html#Q__怎样联系组长？">怎样联系组长？</a></p>
|
||||
<p><img src="./images/usage/manage_ask.png" /></p>
|
||||
<ul>
|
||||
<li>想创建分组，请看: <a href="./index-管理分组与项目.html#创建分组">创建分组</a></li><li>想创建项目，请看: <a href="./index-管理分组与项目.html#创建项目">创建项目</a></li></ul>
|
||||
<blockquote>
|
||||
<p>想了解更多权限信息，请查看<a href="./index-管理分组与项目.html#权限列表">权限列表</a></p>
|
||||
</blockquote>
|
||||
<h2 class="subject" id="选择项目">选择项目 <a class="hashlink" href="#选择项目">#</a></h2><ul>
|
||||
<li><p>如果你已经登录，会在首页右侧看到一些项目 (可以在左侧的分组列表切换分组来查看不同分组下的项目)。</p>
|
||||
</li><li><p>点击一个项目，进入该项目的详情页。</p>
|
||||
</li></ul>
|
||||
<blockquote>
|
||||
<p>如果没有找到项目，请联系组长</p>
|
||||
</blockquote>
|
||||
<p><img src="./images/project_list.png" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
|
||||
<h2 class="subject" id="新建接口">新建接口 <a class="hashlink" href="#新建接口">#</a></h2><ul>
|
||||
<li>点击左侧接口分组右侧的菜单按钮，选择 <code>添加接口</code>，或者点击接口列表右上角的 <code>添加接口</code>。</li></ul>
|
||||
@ -151,9 +161,6 @@
|
||||
<ul>
|
||||
<li>选择接口分类，输入接口名称和接口路径，点击 <code>提交</code>。</li></ul>
|
||||
<p><img src="./images/usage/api_add_panel.png" /></p>
|
||||
<blockquote>
|
||||
<p>如果没有新建项目权限，请联系组长</p>
|
||||
</blockquote>
|
||||
<ul>
|
||||
<li>恭喜你！创建了第一个YApi的接口，你可以看到在左侧看到接口名称，右侧有该接口的信息预览。</li></ul>
|
||||
<p><img src="./images/usage/api_res.png" /></p>
|
||||
|
||||
205
static/doc/index-常见问题.html
Normal file
205
static/doc/index-常见问题.html
Normal file
@ -0,0 +1,205 @@
|
||||
<!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"></button>
|
||||
<nav class="ydoc-nav">
|
||||
<ul class="navbar-left">
|
||||
|
||||
<li class="active">
|
||||
|
||||
<a href="index.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="index-认识 YApi.html">认识 YApi</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-创建第一个API.html">创建第一个API</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-管理分组与项目.html">管理分组与项目</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-项目操作.html">项目操作</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-接口操作.html">接口操作</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-使用mock功能.html">使用mock功能</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-使用测试集.html">使用测试集</a>
|
||||
</li>
|
||||
|
||||
<!-- <li class="active" class="active" > -->
|
||||
<li class="active" >
|
||||
|
||||
<a href="index-常见问题.html">常见问题</a>
|
||||
</li>
|
||||
|
||||
<ul class="nav docs-sidenav-extend" >
|
||||
|
||||
<li >
|
||||
<a href="#Q__怎样联系组长？">Q: 怎样联系组长？</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<div class="content-right markdown-body use-sidebar" role="main">
|
||||
|
||||
<p>本页面罗列了大家使用 YApi 时遇到的常见问题.</p>
|
||||
<p>如果没有找到您要的答案，请 qtalk 联系: <code>wenbo.dong; wenxiong.su; wenjie.zhang.</code></p>
|
||||
<h2 class="subject" id="Q__怎样联系组长？">Q: 怎样联系组长？ <a class="hashlink" href="#Q__怎样联系组长？">#</a></h2><p>A: 组长分为 <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> 的权限信息。
|
||||
<img src="./images/usage/manage_find_project_owner.png" /></li></ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 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>
|
||||
@ -119,6 +119,12 @@
|
||||
|
||||
<a href="index-使用测试集.html">使用测试集</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-常见问题.html">常见问题</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@ -90,6 +90,14 @@
|
||||
<a href="#认识组长">认识组长</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#创建分组">创建分组</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#创建项目">创建项目</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#权限列表">权限列表</a>
|
||||
</li>
|
||||
@ -119,6 +127,12 @@
|
||||
|
||||
<a href="index-使用测试集.html">使用测试集</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-常见问题.html">常见问题</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@ -131,11 +145,15 @@
|
||||
<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>
|
||||
<h3 class="subject" id="如何成为组长？">如何成为组长？ <a class="hashlink" href="#如何成为组长？">#</a></h3><blockquote>
|
||||
<h2 class="subject" id="创建分组">创建分组 <a class="hashlink" href="#创建分组">#</a></h2><p>只有 <code>超级管理员</code> 有权限创建分组</p>
|
||||
<ul>
|
||||
<li>联系超级管理员，说明要创建的分组名称和自己的用户名。</li></ul>
|
||||
</blockquote>
|
||||
<h2 class="subject" id="权限列表">权限列表 <a class="hashlink" href="#权限列表">#</a></h2><p>新用户未加入项目或分组时，是 <code>“游客”</code></p>
|
||||
<li>联系超级管理员<code>(Qtalk: wenbo.dong; wenxiong.su; wenjie.zhang.)</code>，说明要创建的分组名称和自己的用户名。</li><li>分组一般以 BU 作为维度。</li></ul>
|
||||
<h2 class="subject" id="创建项目">创建项目 <a class="hashlink" href="#创建项目">#</a></h2><p>只有 <code>分组组长</code> 和 <code>超级管理员</code> 有权限创建项目。</p>
|
||||
<p><img src="./images/usage/manage_ask_group.png" /></p>
|
||||
<ul>
|
||||
<li>想成为 <code>分组组长</code> ，在分组成员列表中找到 <code>分组组长</code>，联系 <code>分组组长</code> 将你设置为分组组长。</li></ul>
|
||||
<p><a href="./index-常见问题.html#Q__怎样联系组长？">怎样联系组长？</a></p>
|
||||
<h2 class="subject" id="权限列表">权限列表 <a class="hashlink" href="#权限列表">#</a></h2><p>新用户未加入项目或分组时，我们称为 <code>“游客”</code>。</p>
|
||||
<h3 class="subject" id="项目权限">项目权限 <a class="hashlink" href="#项目权限">#</a></h3><table>
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
@ -127,6 +127,12 @@
|
||||
|
||||
<a href="index-使用测试集.html">使用测试集</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-常见问题.html">常见问题</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@ -123,6 +123,12 @@
|
||||
|
||||
<a href="index-使用测试集.html">使用测试集</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-常见问题.html">常见问题</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@ -107,6 +107,12 @@
|
||||
|
||||
<a href="index-使用测试集.html">使用测试集</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="index-常见问题.html">常见问题</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user