mirror of
https://github.com/YMFE/yapi.git
synced 2025-01-06 12:45:22 +08:00
docs: build
This commit is contained in:
parent
b426ac7d74
commit
d2f438add3
Binary file not shown.
Before Width: | Height: | Size: 273 KiB After Width: | Height: | Size: 172 KiB |
@ -4,7 +4,7 @@ YApi 是高效、易用、功能强大的api管理平台。
|
||||
在开始使用 YApi 之前,我们先来熟悉一下 YApi 的网站结构,这将让你快速了解YApi。
|
||||
|
||||
## 登录与注册
|
||||
想要使用 YApi ,首先要拥有账号,目前支持注册账号登录与QSSO登录两种方式。
|
||||
想要使用 YApi ,首先要注册账号。
|
||||
|
||||
<img src="./images/usage/login.png" />
|
||||
|
||||
|
@ -13,9 +13,11 @@
|
||||
|
||||
## 获取权限
|
||||
|
||||
新用户登录后没有任何项目或分组的权限,只能浏览已存在分组下面的公开项目。
|
||||
新用户登录拥有 `个人空间` 分组下的全部权限,个人空间分组仅自己可见,因此可以在这里任意试用 YApi 的功能。
|
||||
|
||||
如果找不到想找的项目,可能是未成为项目成员,此时应联系 `项目组长` 将你加入该项目。
|
||||
除此以外没有任何项目或分组的权限,只能浏览已存在分组下面的公开项目。
|
||||
|
||||
如果找不到想找的项目,可能是尚未成为项目成员,此时应联系 `项目组长` 将你加入该项目。
|
||||
|
||||
[怎样联系组长?](./qa.html#Q__怎样联系组长?)
|
||||
|
||||
|
@ -169,7 +169,7 @@
|
||||
<p>YApi 是高效、易用、功能强大的api管理平台。
|
||||
<!-- 它有扁平化的管理结构(`超管`-`组长`-`组员`),有清晰的接口组织方式(`分组`-`项目`-`接口`),有更方便的mock方案。 --></p>
|
||||
<p>在开始使用 YApi 之前,我们先来熟悉一下 YApi 的网站结构,这将让你快速了解YApi。</p>
|
||||
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ,首先要拥有账号,目前支持注册账号登录与QSSO登录两种方式。</p>
|
||||
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ,首先要注册账号。</p>
|
||||
<p><img src="./images/usage/login.png" /></p>
|
||||
<h2 class="subject" id="首页">首页 <a class="hashlink" href="#首页">#</a></h2><p>登录后进入首页,首页展示了分组与项目。</p>
|
||||
<p>此时你作为新用户,没有任何分组与项目的权限,因此只能搜索、浏览 “公开项目” 的接口,如果在首页找不到任何项目,请联系管理员将你加入对应项目。</p>
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 273 KiB After Width: | Height: | Size: 172 KiB |
@ -149,7 +149,7 @@
|
||||
<p>YApi 是高效、易用、功能强大的api管理平台。
|
||||
<!-- 它有扁平化的管理结构(`超管`-`组长`-`组员`),有清晰的接口组织方式(`分组`-`项目`-`接口`),有更方便的mock方案。 --></p>
|
||||
<p>在开始使用 YApi 之前,我们先来熟悉一下 YApi 的网站结构,这将让你快速了解YApi。</p>
|
||||
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ,首先要拥有账号,目前支持注册账号登录与QSSO登录两种方式。</p>
|
||||
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ,首先要注册账号。</p>
|
||||
<p><img src="./images/usage/login.png" /></p>
|
||||
<h2 class="subject" id="首页">首页 <a class="hashlink" href="#首页">#</a></h2><p>登录后进入首页,首页展示了分组与项目。</p>
|
||||
<p>此时你作为新用户,没有任何分组与项目的权限,因此只能搜索、浏览 “公开项目” 的接口,如果在首页找不到任何项目,请联系管理员将你加入对应项目。</p>
|
||||
|
@ -149,6 +149,10 @@
|
||||
<li >
|
||||
<a href="#Q2__怎么快速把之前项目接口迁移过来?">Q2: 怎么快速把之前项目接口迁移过来?</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#Q3__忘记密码怎么办?">Q3: 忘记密码怎么办?</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
@ -160,7 +164,7 @@
|
||||
|
||||
<p>本页面罗列了大家使用 YApi 时遇到的常见问题.</p>
|
||||
<p>如果没有找到您要的答案,请 qtalk 联系: <code>wenbo.dong; wenxiong.su; wenjie.zhang.</code></p>
|
||||
<h2 class="subject" id="Q1__怎样联系组长?">Q1: 怎样联系组长? <a class="hashlink" href="#Q1__怎样联系组长?">#</a></h2><p>A: 组长分为 <code>分组组长</code> 和 <code>项目组长</code>:</p>
|
||||
<h2 class="subject" id="Q1__怎样联系组长?">Q1: 怎样联系组长? <a class="hashlink" href="#Q1__怎样联系组长?">#</a></h2><p>组长分为 <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> 的权限信息。
|
||||
@ -169,6 +173,7 @@
|
||||
<p>第二步 录制当前项目所有请求,导出到har文件</p>
|
||||
<p>第三步 将Har数据导入到YApi平台</p>
|
||||
<p>具体使用方法请参考YApi<a href="./data.html#HAR%08%08_数据导入">文档</a></p>
|
||||
<h2 class="subject" id="Q3__忘记密码怎么办?">Q3: 忘记密码怎么办? <a class="hashlink" href="#Q3__忘记密码怎么办?">#</a></h2><p>请联系 <code>超级管理员</code> ,只有超级管理员能重置密码。</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
@ -167,8 +167,9 @@
|
||||
<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><p>新用户登录后没有任何项目或分组的权限,只能浏览已存在分组下面的公开项目。</p>
|
||||
<p>如果找不到想找的项目,可能是未成为项目成员,此时应联系 <code>项目组长</code> 将你加入该项目。</p>
|
||||
<h2 class="subject" id="获取权限">获取权限 <a class="hashlink" href="#获取权限">#</a></h2><p>新用户登录拥有 <code>个人空间</code> 分组下的全部权限,个人空间分组仅自己可见,因此可以在这里任意试用 YApi 的功能。</p>
|
||||
<p>除此以外没有任何项目或分组的权限,只能浏览已存在分组下面的公开项目。</p>
|
||||
<p>如果找不到想找的项目,可能是尚未成为项目成员,此时应联系 <code>项目组长</code> 将你加入该项目。</p>
|
||||
<p><a href="./qa.html#Q__怎样联系组长?">怎样联系组长?</a></p>
|
||||
<p><img src="./images/usage/manage_ask.png" /></p>
|
||||
<ul>
|
||||
|
@ -8,6 +8,7 @@ $(document).ready(function() {
|
||||
var $versionSelector = $('.version-selector');
|
||||
var $versionMask = $('.m-version-mask');
|
||||
var isPanelHide = true;
|
||||
var winWidth = $(window).width();
|
||||
var h2 = $('.content-right').find('h2');
|
||||
var h3 = $('.content-right').find('h3');
|
||||
var a = $('.content-left').find('a');
|
||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user