2017-07-31 20:23:22 +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">
|
|
|
|
|
|
<title>YApi 接口管理</title>
|
|
|
|
|
|
<link rel="stylesheet" href="source/main.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="">
|
|
|
|
|
|
|
|
|
|
|
|
<a href="index.html">首页</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<li class="active">
|
|
|
|
|
|
|
|
|
|
|
|
<a href="interface.html">接口管理</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<a href="mock.html">Mock功能</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">
|
|
|
|
|
|
|
2017-08-01 00:15:36 +08:00
|
|
|
|
<div class="ydoc-container-content " id="readme">
|
2017-07-31 20:23:22 +08:00
|
|
|
|
|
2017-08-01 00:15:36 +08:00
|
|
|
|
<article class="markdown-body">
|
2017-08-15 12:08:59 +08:00
|
|
|
|
<h2 class="subject" id="快速开始">快速开始 <a class="hashlink" href="#快速开始">#</a></h2><h3 class="subject" id="1_接口管理架构">1 接口管理架构 <a class="hashlink" href="#1_接口管理架构">#</a></h3><p>平台以<strong>项目分组</strong> -> <strong>项目</strong> -> <strong>接口</strong>的划分进行接口组织管理。</p>
|
2017-07-31 20:23:22 +08:00
|
|
|
|
<p><img src="http://upload-images.jianshu.io/upload_images/842107-305ba49a60ee1ff5.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
|
2017-08-15 12:08:59 +08:00
|
|
|
|
<h4 class="subject" id="1.1_项目分组">1.1 项目分组 <a class="hashlink" href="#1.1_项目分组">#</a></h4><p>登录之后进到项目首页，左边侧边栏显示的即分组列表。</p>
|
2017-07-31 20:23:22 +08:00
|
|
|
|
<p><img src="http://upload-images.jianshu.io/upload_images/842107-d90ca4b3242fa760.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "200" style="margin-left:170px;display:block;" alt="图片名称" align=center /></p>
|
|
|
|
|
|
<p>管理员有权限添加或删除分组。</p>
|
|
|
|
|
|
<p><img src="http://upload-images.jianshu.io/upload_images/842107-a0d4d9a98003896a.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "500" style="margin-left:170px;display:block;" alt="图片名称" align=center /></p>
|
|
|
|
|
|
<blockquote>
|
|
|
|
|
|
<p>分组名称具有唯一性</p>
|
|
|
|
|
|
</blockquote>
|
2017-08-15 12:08:59 +08:00
|
|
|
|
<h4 class="subject" id="1.2_项目">1.2 项目 <a class="hashlink" href="#1.2_项目">#</a></h4><p>选中不同的分组，右边会显示该分组下的项目列表。</p>
|
2017-07-31 20:23:22 +08:00
|
|
|
|
<p><img src="http://upload-images.jianshu.io/upload_images/842107-137bcae58b84715e.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
|
|
|
|
|
|
<p>创建项目需要填写项目名称，项目线上域名（添加完成后可配置项目其他环境域名），项目接口基本路径（接口路径前面相同的部分）以及项目描述。</p>
|
|
|
|
|
|
<p><img src="http://upload-images.jianshu.io/upload_images/842107-360a50ddb746f73d.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
|
|
|
|
|
|
<blockquote>
|
|
|
|
|
|
<p>项目『线上域名 + 基本路径』具有唯一性</p>
|
|
|
|
|
|
</blockquote>
|
2017-08-15 12:08:59 +08:00
|
|
|
|
<h4 class="subject" id="1.3_接口">1.3 接口 <a class="hashlink" href="#1.3_接口">#</a></h4><p>点击项目名称，进入该项目接口列表。</p>
|
2017-07-31 20:23:22 +08:00
|
|
|
|
<p><img src="http://upload-images.jianshu.io/upload_images/842107-e858005f714f4889.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
|
|
|
|
|
|
<p>点击编辑，进入接口详情页（之后接口详情页和编辑也会分开），可以编辑接口或者请求测试真实接口。</p>
|
|
|
|
|
|
<p><img src="http://upload-images.jianshu.io/upload_images/842107-78c0ea839619d068.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
|
|
|
|
|
|
<p><img src="http://upload-images.jianshu.io/upload_images/842107-2ee7171d707e91ff.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
|
|
|
|
|
|
|
2017-08-01 00:15:36 +08:00
|
|
|
|
</article>
|
2017-07-31 20:23:22 +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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script src="source/main.js"></script>
|
|
|
|
|
|
<script src="source/app.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
|
var lineHeight = 17.4;
|
|
|
|
|
|
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-08-15 12:08:59 +08:00
|
|
|
|
$this.parent().children('.js-code').height('auto');
|
|
|
|
|
|
$this.parent().height('auto');
|
2017-07-31 20:23:22 +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-08-15 12:08:59 +08:00
|
|
|
|
$this.parent().children('.js-code').height(EXAMPLE_MAX_HEIGHT); // code
|
2017-07-31 20:23:22 +08:00
|
|
|
|
$this.html("展开更多……");
|
|
|
|
|
|
});
|
|
|
|
|
|
}
|
|
|
|
|
|
$(document).ready(fold);
|
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
|
|
|
|
|
|
|
</html>
|
