2017-08-21 21:18:55 +08:00
|
|
|
|
<!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">
|
2017-08-31 11:55:24 +08:00
|
|
|
|
<title>YApi 使用手册</title>
|
2017-09-07 18:44:50 +08:00
|
|
|
|
<link rel="stylesheet" href="source/main.css" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="styles/theme.css" />
|
|
|
|
|
|
|
|
|
|
|
|
|
2017-08-21 21:18:55 +08:00
|
|
|
|
</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">
|
|
|
|
|
|
|
2017-09-12 11:58:22 +08:00
|
|
|
|
<a href="index.html">使用手册</a>
|
2017-08-31 11:55:24 +08:00
|
|
|
|
</li>
|
|
|
|
|
|
|
2017-08-21 21:18:55 +08:00
|
|
|
|
<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>
|
2017-09-01 15:59:53 +08:00
|
|
|
|
<p class="desc ">高效、易用、功能强大的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。</p>
|
2017-08-21 21:18:55 +08:00
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="ydoc-container">
|
|
|
|
|
|
|
2017-09-07 18:44:50 +08:00
|
|
|
|
<div class="ydoc-container-content ">
|
2017-08-21 21:18:55 +08:00
|
|
|
|
|
2017-08-30 15:53:48 +08:00
|
|
|
|
|
2017-09-07 18:44:50 +08:00
|
|
|
|
<div class="content-left staticsidenav" role="complementary">
|
2017-08-30 15:53:48 +08:00
|
|
|
|
<nav class="docs-sidebar hidden-print hidden-xs hidden-sm">
|
|
|
|
|
|
<ul class="nav docs-sidenav">
|
|
|
|
|
|
|
2017-08-31 11:55:24 +08:00
|
|
|
|
<!-- <li class="active" class="active" > -->
|
|
|
|
|
|
<li class="active" >
|
2017-08-30 15:53:48 +08:00
|
|
|
|
|
2017-09-12 11:58:22 +08:00
|
|
|
|
<a href="index-认识 YApi.html">认识 YApi</a>
|
2017-08-30 15:53:48 +08:00
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="nav docs-sidenav-extend" >
|
|
|
|
|
|
|
|
|
|
|
|
<li >
|
2017-08-31 11:55:24 +08:00
|
|
|
|
<a href="#登录与注册">登录与注册</a>
|
2017-08-30 15:53:48 +08:00
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<li >
|
2017-08-31 11:55:24 +08:00
|
|
|
|
<a href="#首页">首页</a>
|
2017-08-30 15:53:48 +08:00
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<li >
|
2017-08-31 11:55:24 +08:00
|
|
|
|
<a href="#项目页">项目页</a>
|
2017-08-30 15:53:48 +08:00
|
|
|
|
</li>
|
2017-08-31 11:55:24 +08:00
|
|
|
|
|
|
|
|
|
|
<li >
|
2017-08-31 17:08:28 +08:00
|
|
|
|
<a href="#个人中心">个人中心</a>
|
2017-08-31 11:55:24 +08:00
|
|
|
|
</li>
|
|
|
|
|
|
|
2017-08-30 15:53:48 +08:00
|
|
|
|
</ul>
|
2017-08-31 11:55:24 +08:00
|
|
|
|
|
|
|
|
|
|
<!-- <li > -->
|
|
|
|
|
|
<li >
|
|
|
|
|
|
|
2017-09-12 11:58:22 +08:00
|
|
|
|
<a href="index-创建第一个API.html">创建第一个API</a>
|
2017-08-31 11:55:24 +08:00
|
|
|
|
</li>
|
|
|
|
|
|
|
2017-09-04 11:50:36 +08:00
|
|
|
|
<!-- <li > -->
|
|
|
|
|
|
<li >
|
|
|
|
|
|
|
2017-09-12 11:58:22 +08:00
|
|
|
|
<a href="index-管理分组与项目.html">管理分组与项目</a>
|
2017-09-04 11:50:36 +08:00
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- <li > -->
|
|
|
|
|
|
<li >
|
|
|
|
|
|
|
2017-09-12 11:58:22 +08:00
|
|
|
|
<a href="index-项目操作.html">项目操作</a>
|
2017-09-06 15:40:45 +08:00
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- <li > -->
|
|
|
|
|
|
<li >
|
|
|
|
|
|
|
2017-09-12 11:58:22 +08:00
|
|
|
|
<a href="index-接口操作.html">接口操作</a>
|
2017-09-04 11:50:36 +08:00
|
|
|
|
</li>
|
|
|
|
|
|
|
2017-08-31 11:55:24 +08:00
|
|
|
|
<!-- <li > -->
|
|
|
|
|
|
<li >
|
|
|
|
|
|
|
2017-09-12 11:58:22 +08:00
|
|
|
|
<a href="index-使用mock功能.html">使用mock功能</a>
|
2017-08-31 11:55:24 +08:00
|
|
|
|
</li>
|
2017-09-04 11:50:36 +08:00
|
|
|
|
|
|
|
|
|
|
<!-- <li > -->
|
|
|
|
|
|
<li >
|
|
|
|
|
|
|
2017-09-12 11:58:22 +08:00
|
|
|
|
<a href="index-使用测试集.html">使用测试集</a>
|
2017-09-04 11:50:36 +08:00
|
|
|
|
</li>
|
2017-08-31 11:55:24 +08:00
|
|
|
|
|
2017-08-30 15:53:48 +08:00
|
|
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
2017-09-07 18:44:50 +08:00
|
|
|
|
<div class="content-right markdown-body use-sidebar" role="main">
|
2017-08-30 15:53:48 +08:00
|
|
|
|
|
2017-08-31 17:08:28 +08:00
|
|
|
|
<p>YApi 是高效、易用、功能强大的api管理平台。
|
|
|
|
|
|
<!-- 它有扁平化的管理结构(`超管`-`组长`-`组员`)，有清晰的接口组织方式(`分组`-`项目`-`接口`)，有更方便的mock方案。 --></p>
|
|
|
|
|
|
<p>在开始使用 YApi 之前，我们先来熟悉一下 YApi 的网站结构，这将让你快速了解YApi。</p>
|
2017-09-04 11:33:10 +08:00
|
|
|
|
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。</p>
|
|
|
|
|
|
<p><img src="./images/usage/login.png" /></p>
|
2017-08-31 17:08:28 +08:00
|
|
|
|
<h2 class="subject" id="首页">首页 <a class="hashlink" href="#首页">#</a></h2><p>登录后进入首页，首页展示了分组与项目。</p>
|
|
|
|
|
|
<p>此时你作为新用户，没有任何分组与项目的权限，因此只能搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。</p>
|
2017-09-04 11:33:10 +08:00
|
|
|
|
<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>
|
2017-08-31 17:08:28 +08:00
|
|
|
|
<p><img src="./images/usage/index.png" /></p>
|
|
|
|
|
|
<h2 class="subject" id="项目页">项目页 <a class="hashlink" href="#项目页">#</a></h2><p>点击一个项目，进入项目页，项目页展示了属于该项目的全部接口，并提供项目、接口的全部操作。</p>
|
|
|
|
|
|
<p>此时你作为新用户，只能浏览接口信息，不可以编辑项目或接口，如果需要编辑，请联系管理员将你加入该项目。</p>
|
2017-09-04 11:33:10 +08:00
|
|
|
|
<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>
|
2017-08-31 17:08:28 +08:00
|
|
|
|
<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>
|
|
|
|
|
|
<p>在个人信息页面可以查看并修改自己的用户名、密码等信息。</p>
|
|
|
|
|
|
<p><img src="./images/usage/user.png" /></p>
|
|
|
|
|
|
|
2017-08-30 15:53:48 +08:00
|
|
|
|
</div>
|
2017-08-21 21:18:55 +08:00
|
|
|
|
</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>
|
|
|
|
|
|
|
2017-08-30 15:53:48 +08:00
|
|
|
|
|
|
|
|
|
|
<div class="open-panel"></div>
|
|
|
|
|
|
<div class="mask"></div>
|
2017-08-21 21:18:55 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script src="source/main.js"></script>
|
|
|
|
|
|
<script src="source/app.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script>
|
2017-09-07 18:44:50 +08:00
|
|
|
|
var lineHeight = 18;
|
2017-08-21 21:18:55 +08:00
|
|
|
|
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('折叠代码');
|
2017-09-07 18:44:50 +08:00
|
|
|
|
$this.parent().children('.js-code').height('auto');
|
|
|
|
|
|
$this.parent().height('auto');
|
2017-08-21 21:18:55 +08:00
|
|
|
|
});
|
|
|
|
|
|
$('.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
|
2017-09-07 18:44:50 +08:00
|
|
|
|
$this.parent().children('.js-code').height(EXAMPLE_MAX_HEIGHT); // code
|
2017-08-21 21:18:55 +08:00
|
|
|
|
$this.html("展开更多……");
|
|
|
|
|
|
});
|
|
|
|
|
|
}
|
|
|
|
|
|
$(document).ready(fold);
|
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
|
|
|
|
|
|
|
</html>
|
