mirror of
https://github.com/YMFE/yapi.git
synced 2025-01-06 12:45:22 +08:00
Merge branch 'dev' of gitlab.corp.qunar.com:mfe/yapi into dev
This commit is contained in:
suxiaoxin
commit
988af1999f
Binary file not shown.
|
Before Width: | Height: | Size: 144 KiB |
BIN
doc/images/usage/project_add.png
Normal file
BIN
doc/images/usage/project_add.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
BIN
doc/images/usage/project_add_panel.png
Normal file
BIN
doc/images/usage/project_add_panel.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 39 KiB |
BIN
doc/images/usage/project_setting.png
Normal file
BIN
doc/images/usage/project_setting.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
BIN
doc/images/usage/project_setting_env.png
Normal file
BIN
doc/images/usage/project_setting_env.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
BIN
doc/images/usage/project_setting_logo.png
Normal file
BIN
doc/images/usage/project_setting_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
@ -2,12 +2,23 @@
|
||||
|
||||
## 接口配置
|
||||
|
||||
#### 4.3 接口编辑
|
||||
添加完接口点击新添加的接口，跳转到接口预览页面，可看到刚才填写的信息。接口的详细信息点击编辑功能进行添加
|
||||
[新建接口](./usage-创建第一个API.html#新建_编辑接口) 后，点击新添加的接口，右侧可以看到接口的预览信息，点击右侧的 `编辑` Tab项进入编辑面板。
|
||||
|
||||
#### 4.4 测试接口
|
||||
点击运行tab,可进入到接口测试页面，首先安装chrome crossRequest扩展，才可正常使用此功能
|
||||
<img src="./images/interface_run.png" width="800" style="margin:0px auto;display:block;" alt="图片名称" align=center />
|
||||
点击保存按钮可把当前测试保存到测试集，方便下次调试
|
||||
在改面板中你可以看到接口的基本信息(接口名称、分类、路径)，除此以外，你还可以完善以下接口信息：
|
||||
|
||||
- 状态: 用于标识接口是否开发完成。
|
||||
- 接口描述: 用简短的文字描述接口的作用。
|
||||
- query: 接口url的查询字符串。
|
||||
- 请求 Headers: http 请求头字段。
|
||||
- 请求 Body: http 请求 body 部分。
|
||||
- 请求 Body: http 请求 body 部分。
|
||||
- 响应 Body: 模拟返回结果。
|
||||
> 响应 Body 分为 `json` & `raw` 两种形式
|
||||
|
||||
- 是否开启邮件通知：开启后将此次接口的改动以邮件的形式发送至项目组所有成员。
|
||||
|
||||
## 接口调试
|
||||
|
||||
<!-- 点击运行tab,可进入到接口测试页面，首先安装chrome crossRequest扩展，才可正常使用此功能
|
||||
<img src="./images/interface_run.png" width="800" style="margin:0px auto;display:block;" alt="图片名称" align=center />
|
||||
点击保存按钮可把当前测试保存到测试集，方便下次调试 -->
|
||||
|
||||
@ -1,3 +1,39 @@
|
||||
## 新建项目
|
||||
|
||||
点击右上角的 `+` 新建项目，进入新建项目页面。
|
||||
|
||||
<img src="./images/usage/project_add.png" />
|
||||
|
||||
在新建项目页，填写项目信息：
|
||||
|
||||
> - 项目名称不允许重复，包括其他分组
|
||||
> - 基本路径为接口统一添加了前缀
|
||||
> - 新建项目页只列出了部分配置，其他详细配置(环境配置、项目图标等)需要进入项目页的“设置”面板进行配置。
|
||||
|
||||
<img src="./images/usage/project_add_panel.png" />
|
||||
|
||||
## 修改项目
|
||||
|
||||
在项目页点击上方的 `设置` Tab 进入项目设置面板，这个面板涵盖了项目的所有配置。
|
||||
|
||||
<img src="./images/usage/project_setting.png" />
|
||||
|
||||
这里比新建项目页面新增的功能如下：
|
||||
|
||||
### 修改项目图标
|
||||
|
||||
点击项目图标，可以修改图标及背景色：
|
||||
|
||||
<img src="./images/usage/project_setting_logo.png" />
|
||||
|
||||
### 配置环境
|
||||
|
||||
`环境配置` 一项可以添加该项目下接口的实际环境，供 [接口测试](./usage-使用测试集.html) 使用。
|
||||
|
||||
<img src="./images/usage/project_setting_env.png" />
|
||||
|
||||
## 删除项目
|
||||
|
||||
点击下方的删除按钮，输入项目名称进行删除。
|
||||
|
||||
> 删除项目是高风险操作，因此 YApi 对这个操作进行了特别的约束。
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 144 KiB |
BIN
static/doc/images/usage/project_add.png
Normal file
BIN
static/doc/images/usage/project_add.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
BIN
static/doc/images/usage/project_add_panel.png
Normal file
BIN
static/doc/images/usage/project_add_panel.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 39 KiB |
BIN
static/doc/images/usage/project_setting.png
Normal file
BIN
static/doc/images/usage/project_setting.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
BIN
static/doc/images/usage/project_setting_env.png
Normal file
BIN
static/doc/images/usage/project_setting_env.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
BIN
static/doc/images/usage/project_setting_logo.png
Normal file
BIN
static/doc/images/usage/project_setting_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
@ -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" > -->
|
||||
|
||||
@ -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 > -->
|
||||
|
||||
@ -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 > -->
|
||||
|
||||
@ -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" >
|
||||
@ -134,11 +140,19 @@
|
||||
|
||||
<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><h4 class="subject" id="4.3_接口编辑">4.3 接口编辑 <a class="hashlink" href="#4.3_接口编辑">#</a></h4><p>添加完接口点击新添加的接口，跳转到接口预览页面，可看到刚才填写的信息。接口的详细信息点击编辑功能进行添加</p>
|
||||
<h4 class="subject" id="4.4_测试接口">4.4 测试接口 <a class="hashlink" href="#4.4_测试接口">#</a></h4><p>点击运行tab,可进入到接口测试页面，首先安装chrome crossRequest扩展，才可正常使用此功能
|
||||
<h2 class="subject" id="介绍">介绍 <a class="hashlink" href="#介绍">#</a></h2><h2 class="subject" id="接口配置">接口配置 <a class="hashlink" href="#接口配置">#</a></h2><p><a href="./usage-创建第一个API.html#新建_编辑接口">新建接口</a> 后，点击新添加的接口，右侧可以看到接口的预览信息，点击右侧的 <code>编辑</code> Tab项进入编辑面板。</p>
|
||||
<p>在改面板中你可以看到接口的基本信息(接口名称、分类、路径)，除此以外，你还可以完善以下接口信息：</p>
|
||||
<ul>
|
||||
<li>状态: 用于标识接口是否开发完成。</li><li>接口描述: 用简短的文字描述接口的作用。</li><li>query: 接口url的查询字符串。</li><li>请求 Headers: http 请求头字段。</li><li>请求 Body: http 请求 body 部分。</li><li>请求 Body: http 请求 body 部分。</li><li><p>响应 Body: 模拟返回结果。</p>
|
||||
<blockquote>
|
||||
<p>响应 Body 分为 <code>json</code> & <code>raw</code> 两种形式</p>
|
||||
</blockquote>
|
||||
</li><li><p>是否开启邮件通知：开启后将此次接口的改动以邮件的形式发送至项目组所有成员。</p>
|
||||
</li></ul>
|
||||
<h2 class="subject" id="接口调试">接口调试 <a class="hashlink" href="#接口调试">#</a></h2><!-- 点击运行tab,可进入到接口测试页面，首先安装chrome crossRequest扩展，才可正常使用此功能
|
||||
<img src="./images/interface_run.png" width="800" style="margin:0px auto;display:block;" alt="图片名称" align=center />
|
||||
点击保存按钮可把当前测试保存到测试集，方便下次调试</p>
|
||||
<h2 class="subject" id="接口调试">接口调试 <a class="hashlink" href="#接口调试">#</a></h2>
|
||||
点击保存按钮可把当前测试保存到测试集，方便下次调试 -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
321
static/doc/usage-管理分组与项目.html
Normal file
321
static/doc/usage-管理分组与项目.html
Normal file
@ -0,0 +1,321 @@
|
||||
<!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="">
|
||||
|
||||
<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 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-接口操作.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">
|
||||
|
||||
<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:center">游客</th>
|
||||
<th style="text-align:center">开发者</th>
|
||||
<th style="text-align:center">组长</th>
|
||||
<th style="text-align:center">超级管理员</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="text-align:left">浏览公开项目与接口</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">浏览私有项目与接口</td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">编辑项目信息</td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">新建接口</td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">编辑接口</td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">编辑项目头像</td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">删除项目</td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 class="subject" id="分组权限">分组权限 <a class="hashlink" href="#分组权限">#</a></h3><table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="text-align:left">操作</th>
|
||||
<th style="text-align:center">游客</th>
|
||||
<th style="text-align:center">开发者</th>
|
||||
<th style="text-align:center">组长</th>
|
||||
<th style="text-align:center">超级管理员</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="text-align:left">浏览分组</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">在分组中新建项目</td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">编辑分组信息</td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">管理分组成员</td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">删除分组</td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center"></td>
|
||||
<td style="text-align:center">✓</td>
|
||||
<td style="text-align:center">✓</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</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>
|
||||
@ -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 > -->
|
||||
|
||||
@ -88,28 +88,30 @@
|
||||
<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>
|
||||
<a href="usage-项目操作.html">项目操作</a>
|
||||
</li>
|
||||
|
||||
<ul class="nav docs-sidenav-extend" >
|
||||
|
||||
<li >
|
||||
<a href="#介绍">介绍</a>
|
||||
<a href="#新建项目">新建项目</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#组长职责">组长职责</a>
|
||||
<a href="#修改项目">修改项目</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#安装_crossRequest_chrome_插件">安装 crossRequest chrome 插件</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#权限列表">权限列表</a>
|
||||
<a href="#删除项目">删除项目</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@ -117,7 +119,7 @@
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="usage-接口配置与调试.html">接口配置与调试</a>
|
||||
<a href="usage-接口操作.html">接口操作</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
@ -138,7 +140,26 @@
|
||||
|
||||
<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>
|
||||
<h2 class="subject" id="新建项目">新建项目 <a class="hashlink" href="#新建项目">#</a></h2><p>点击右上角的 <code>+</code> 新建项目，进入新建项目页面。</p>
|
||||
<p><img src="./images/usage/project_add.png" /></p>
|
||||
<p>在新建项目页，填写项目信息：</p>
|
||||
<blockquote>
|
||||
<ul>
|
||||
<li>项目名称不允许重复，包括其他分组</li><li>基本路径为接口统一添加了前缀</li><li>新建项目页只列出了部分配置，其他详细配置(环境配置、项目图标等)需要进入项目页的“设置”面板进行配置。</li></ul>
|
||||
</blockquote>
|
||||
<p><img src="./images/usage/project_add_panel.png" /></p>
|
||||
<h2 class="subject" id="修改项目">修改项目 <a class="hashlink" href="#修改项目">#</a></h2><p>在项目页点击上方的 <code>设置</code> Tab 进入项目设置面板，这个面板涵盖了项目的所有配置。</p>
|
||||
<p><img src="./images/usage/project_setting.png" /></p>
|
||||
<p>这里比新建项目页面新增的功能如下：</p>
|
||||
<h3 class="subject" id="修改项目图标">修改项目图标 <a class="hashlink" href="#修改项目图标">#</a></h3><p>点击项目图标，可以修改图标及背景色：</p>
|
||||
<p><img src="./images/usage/project_setting_logo.png" /></p>
|
||||
<h3 class="subject" id="配置环境">配置环境 <a class="hashlink" href="#配置环境">#</a></h3><p><code>环境配置</code> 一项可以添加该项目下接口的实际环境，供 <a href="./usage-使用测试集.html">接口测试</a> 使用。</p>
|
||||
<p><img src="./images/usage/project_setting_env.png" /></p>
|
||||
<h2 class="subject" id="删除项目">删除项目 <a class="hashlink" href="#删除项目">#</a></h2><p>点击下方的删除按钮，输入项目名称进行删除。</p>
|
||||
<blockquote>
|
||||
<p>删除项目是高风险操作，因此 YApi 对这个操作进行了特别的约束。</p>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -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 > -->
|
||||
|
||||
Loading…
Reference in New Issue
Block a user