mirror of
https://github.com/YMFE/yapi.git
synced 2024-12-15 05:10:47 +08:00
Merge branch 'doc' into dev
This commit is contained in:
suxiaoxin
commit
234db7bb25
BIN
doc/images/intro_page_1.png
Normal file
BIN
doc/images/intro_page_1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.5 KiB |
BIN
doc/images/intro_page_2.png
Normal file
BIN
doc/images/intro_page_2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.1 KiB |
BIN
doc/images/intro_page_3.png
Normal file
BIN
doc/images/intro_page_3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.5 KiB |
@ -1,5 +1,5 @@
|
||||
# 内网部署
|
||||
使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。建议部署成 http 站点，因 chrome 浏览器安全限制，部署成 https 会导致 测试功能的文件上传功能异常。
|
||||
使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。建议部署成 http 站点，因 chrome 浏览器安全限制，部署成 https 会导致测试功能在请求 http 站点时文件上传功能异常。
|
||||
|
||||
如果您是将服务器代理到 nginx 服务器，请配置 nginx 支持 websocket。
|
||||
```
|
||||
@ -14,11 +14,26 @@ proxy_set_header Connection "upgrade";
|
||||
* mongodb（2.6+）
|
||||
|
||||
## 安装
|
||||
### 方式一. 可视化部署[推荐]
|
||||
执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。
|
||||
```
|
||||
npm install -g yapi-cli --registry https://registry.npm.taobao.org
|
||||
yapi server
|
||||
```
|
||||
### 方式二. 命令行部署
|
||||
|
||||
如果 github 压缩文件无法下载，或需要部署到一些特殊的服务器，可尝试此方法
|
||||
|
||||
```
|
||||
mkdir yapi
|
||||
cd yapi
|
||||
git clone https://github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录
|
||||
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
|
||||
cd vendors
|
||||
npm install --production --registry https://registry.npm.taobao.org
|
||||
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
|
||||
node server/app.js //启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候
|
||||
```
|
||||
|
||||
## 升级
|
||||
升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。
|
||||
|
||||
@ -9,7 +9,7 @@ git clone https://github.com/YMFE/yapi.git vendors
|
||||
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
|
||||
cd vendors
|
||||
npm install
|
||||
node run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
|
||||
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
|
||||
npm run dev //启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候
|
||||
```
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
如果没有找到您要的答案，请联系管理员.
|
||||
|
||||
## Q1: 怎样联系组长？
|
||||
## Q1 怎样联系组长？
|
||||
|
||||
组长分为 `分组组长` 和 `项目组长`:
|
||||
- 分组组长：选择首页左侧的分组，点击右侧面板的 `成员列表`，成员右侧显示着 `组长/开发者` 的权限信息。
|
||||
@ -10,7 +10,7 @@
|
||||
- 项目组长: 点击项目页的 `设置` - `成员列表`，成员右侧显示着 `组长/开发者` 的权限信息。
|
||||
<img src="./images/usage/manage_find_project_owner.png" />
|
||||
|
||||
## Q2: 怎么快速迁移旧项目？
|
||||
## Q2 怎么快速迁移旧项目？
|
||||
|
||||
第一步. 使用 Chrome 浏览器开发者工具录制功能
|
||||
|
||||
@ -20,14 +20,20 @@
|
||||
|
||||
具体使用方法请参考 YApi <a href="./data.html#HAR%08%08_数据导入">文档</a>
|
||||
|
||||
## Q3: 忘记密码怎么办？
|
||||
## Q3 忘记密码怎么办？
|
||||
|
||||
请联系 `超级管理员` ，只有超级管理员能重置密码。
|
||||
|
||||
## 04: 发现了 Bug 怎么办？
|
||||
## Q4 发现了 Bug 怎么办？
|
||||
|
||||
请反馈到 <a href="https://github.com/YMFE/yapi/issues" _blank="target">Github</a>，功能性的问题我们会在一周内修复，并在每周一发布新的版本 Tag.
|
||||
|
||||
## Q5 可视化部署一直处于 github 压缩包下载状态怎么办？
|
||||
|
||||
可按 Ctrl + c 中断部署操作，然后删除之前部署的文件，重新部署。
|
||||
|
||||
如果还是不行，请参考 文档 -> 内网部署 -> <a href="https://yapi.ymfe.org/devops.html#方式二. 命令行部署" >命令行部署</a> 文档
|
||||
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
@ -180,4 +180,14 @@ body, h1, h2, h3, h4, h5, h6 {
|
||||
|
||||
.ydoc .ydoc-header .navbar-brand img{
|
||||
width: 32px;
|
||||
}
|
||||
|
||||
.ydoc .navbar-brand{
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.ydoc .ydoc-banner-home .home-btn:hover{
|
||||
background: #552d84;
|
||||
border: 1px solid;
|
||||
border-color: #fff;
|
||||
}
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
@ -108,7 +108,19 @@
|
||||
|
||||
<a href="#安装">安装</a>
|
||||
</li>
|
||||
|
||||
|
||||
<ul class="nav docs-sidenav-extend" >
|
||||
|
||||
<li >
|
||||
<a href="#方式一. 可视化部署[推荐]">方式一. 可视化部署[推荐]</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#方式二. 命令行部署">方式二. 命令行部署</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
@ -127,7 +139,7 @@
|
||||
|
||||
<div class="content-right markdown-body use-sidebar" role="main">
|
||||
|
||||
<h1 class="subject" id="内网部署">内网部署 <a class="hashlink" href="#内网部署">#</a></h1><p>使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。建议部署成 http 站点，因 chrome 浏览器安全限制，部署成 https 会导致 测试功能的文件上传功能异常。</p>
|
||||
<h1 class="subject" id="内网部署">内网部署 <a class="hashlink" href="#内网部署">#</a></h1><p>使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。建议部署成 http 站点，因 chrome 浏览器安全限制，部署成 https 会导致测试功能在请求 http 站点时文件上传功能异常。</p>
|
||||
<p>如果您是将服务器代理到 nginx 服务器，请配置 nginx 支持 websocket。</p>
|
||||
<pre><code>在location /添加
|
||||
proxy_http_version <span class="token number">1.1</span><span class="token punctuation">;</span>
|
||||
@ -135,9 +147,18 @@ proxy_set_header Upgrade $http_upgrade<span class="token punctuation">;</span>
|
||||
proxy_set_header Connection <span class="token string">"upgrade"</span><span class="token punctuation">;</span>
|
||||
</code></pre><h2 class="subject" id="环境要求">环境要求 <a class="hashlink" href="#环境要求">#</a></h2><ul>
|
||||
<li>nodejs（7.6+)</li><li>mongodb（2.6+）</li></ul>
|
||||
<h2 class="subject" id="安装">安装 <a class="hashlink" href="#安装">#</a></h2><p>执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。</p>
|
||||
<h2 class="subject" id="安装">安装 <a class="hashlink" href="#安装">#</a></h2><h3 class="subject" id="方式一._可视化部署[推荐]">方式一. 可视化部署[推荐] <a class="hashlink" href="#方式一._可视化部署[推荐]">#</a></h3><p>执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。</p>
|
||||
<pre><code>npm install -g yapi-cli --registry https<span class="token operator">:</span>//registry.npm.taobao.org
|
||||
yapi server
|
||||
</code></pre><h3 class="subject" id="方式二._命令行部署">方式二. 命令行部署 <a class="hashlink" href="#方式二._命令行部署">#</a></h3><p>如果 github 压缩文件无法下载，或需要部署到一些特殊的服务器，可尝试此方法</p>
|
||||
<pre><code>mkdir yapi
|
||||
cd yapi
|
||||
git clone https<span class="token operator">:</span>//github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录
|
||||
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
|
||||
cd vendors
|
||||
npm install --production --registry https<span class="token operator">:</span>//registry.npm.taobao.org
|
||||
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
|
||||
node server/app.js //启动服务器后，请访问 <span class="token number">127.0</span>.<span class="token number">0.1</span><span class="token operator">:</span><span class="token punctuation">{</span>config.json配置的端口<span class="token punctuation">}</span>，初次运行会有个编译的过程，请耐心等候
|
||||
</code></pre><h2 class="subject" id="升级">升级 <a class="hashlink" href="#升级">#</a></h2><p>升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。</p>
|
||||
<pre><code>cd <span class="token punctuation">{</span>项目目录<span class="token punctuation">}</span>
|
||||
yapi ls //查看版本号列表
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
BIN
static/doc/images/intro_page_1.png
Normal file
BIN
static/doc/images/intro_page_1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.5 KiB |
BIN
static/doc/images/intro_page_2.png
Normal file
BIN
static/doc/images/intro_page_2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.1 KiB |
BIN
static/doc/images/intro_page_3.png
Normal file
BIN
static/doc/images/intro_page_3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.5 KiB |
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
@ -126,7 +126,7 @@
|
||||
<div class="home-item">
|
||||
|
||||
<div class="home-thumbnail-img">
|
||||
<img class="home-thumbnail-src" src=http://ojk406wln.bkt.clouddn.com/intro_muti.png alt="">
|
||||
<img class="home-thumbnail-src" src=./images/intro_page_1.png alt="">
|
||||
</div>
|
||||
|
||||
<h3 class="home-thumbnail-name">项目管理</h3>
|
||||
@ -136,7 +136,7 @@
|
||||
<div class="home-item">
|
||||
|
||||
<div class="home-thumbnail-img">
|
||||
<img class="home-thumbnail-src" src=http://ojk406wln.bkt.clouddn.com/intro_md.png alt="">
|
||||
<img class="home-thumbnail-src" src=./images/intro_page_2.png alt="">
|
||||
</div>
|
||||
|
||||
<h3 class="home-thumbnail-name">接口管理</h3>
|
||||
@ -146,7 +146,7 @@
|
||||
<div class="home-item">
|
||||
|
||||
<div class="home-thumbnail-img">
|
||||
<img class="home-thumbnail-src" src=http://ojk406wln.bkt.clouddn.com/intro_theme.png alt="">
|
||||
<img class="home-thumbnail-src" src=./images/intro_page_3.png alt="">
|
||||
</div>
|
||||
|
||||
<h3 class="home-thumbnail-name">MockServer</h3>
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
@ -140,7 +140,7 @@ git clone https<span class="token operator">:</span>//github.com/YMFE/yapi.git v
|
||||
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
|
||||
cd vendors
|
||||
npm install
|
||||
node run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
|
||||
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
|
||||
npm run dev //启动服务器后，请访问 <span class="token number">127.0</span>.<span class="token number">0.1</span><span class="token operator">:</span><span class="token punctuation">{</span>config.json配置的端口<span class="token punctuation">}</span>，初次运行会有个编译的过程，请耐心等候
|
||||
</code></pre><h2 class="subject" id="安装成功后的目录结构">安装成功后的目录结构 <a class="hashlink" href="#安装成功后的目录结构">#</a></h2><pre><code>yapi
|
||||
config.json //服务器配置，可参考 vendors/config_example.json
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
@ -100,25 +100,31 @@
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="#Q1: 怎样联系组长？">Q1: 怎样联系组长？</a>
|
||||
<a href="#Q1 怎样联系组长？">Q1 怎样联系组长？</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="#Q2: 怎么快速迁移旧项目？">Q2: 怎么快速迁移旧项目？</a>
|
||||
<a href="#Q2 怎么快速迁移旧项目？">Q2 怎么快速迁移旧项目？</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="#Q3: 忘记密码怎么办？">Q3: 忘记密码怎么办？</a>
|
||||
<a href="#Q3 忘记密码怎么办？">Q3 忘记密码怎么办？</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="#04: 发现了 Bug 怎么办？">04: 发现了 Bug 怎么办？</a>
|
||||
<a href="#Q4 发现了 Bug 怎么办？">Q4 发现了 Bug 怎么办？</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="#Q5 可视化部署一直处于 github 压缩包下载状态怎么办？">Q5 可视化部署一直处于 github 压缩包下载状态怎么办？</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@ -129,17 +135,19 @@
|
||||
|
||||
<p>本页面罗列了大家使用 YApi 时遇到的常见问题.</p>
|
||||
<p>如果没有找到您要的答案，请联系管理员.</p>
|
||||
<h2 class="subject" id="Q1__怎样联系组长？">Q1: 怎样联系组长？ <a class="hashlink" href="#Q1__怎样联系组长？">#</a></h2><p>组长分为 <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> 的权限信息。
|
||||
<img src="./images/usage/manage_find_project_owner.png" /></li></ul>
|
||||
<h2 class="subject" id="Q2__怎么快速迁移旧项目？">Q2: 怎么快速迁移旧项目？ <a class="hashlink" href="#Q2__怎么快速迁移旧项目？">#</a></h2><p>第一步. 使用 Chrome 浏览器开发者工具录制功能</p>
|
||||
<h2 class="subject" id="Q2_怎么快速迁移旧项目？">Q2 怎么快速迁移旧项目？ <a class="hashlink" href="#Q2_怎么快速迁移旧项目？">#</a></h2><p>第一步. 使用 Chrome 浏览器开发者工具录制功能</p>
|
||||
<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>
|
||||
<h2 class="subject" id="04__发现了_Bug_怎么办？">04: 发现了 Bug 怎么办？ <a class="hashlink" href="#04__发现了_Bug_怎么办？">#</a></h2><p>请反馈到 <a href="https://github.com/YMFE/yapi/issues" _blank="target">Github</a>，功能性的问题我们会在一周内修复，并在每周一发布新的版本 Tag.</p>
|
||||
<h2 class="subject" id="Q3_忘记密码怎么办？">Q3 忘记密码怎么办？ <a class="hashlink" href="#Q3_忘记密码怎么办？">#</a></h2><p>请联系 <code>超级管理员</code> ，只有超级管理员能重置密码。</p>
|
||||
<h2 class="subject" id="Q4_发现了_Bug_怎么办？">Q4 发现了 Bug 怎么办？ <a class="hashlink" href="#Q4_发现了_Bug_怎么办？">#</a></h2><p>请反馈到 <a href="https://github.com/YMFE/yapi/issues" _blank="target">Github</a>，功能性的问题我们会在一周内修复，并在每周一发布新的版本 Tag.</p>
|
||||
<h2 class="subject" id="Q5_可视化部署一直处于_github_压缩包下载状态怎么办？">Q5 可视化部署一直处于 github 压缩包下载状态怎么办？ <a class="hashlink" href="#Q5_可视化部署一直处于_github_压缩包下载状态怎么办？">#</a></h2><p>可按 Ctrl + c 中断部署操作，然后删除之前部署的文件，重新部署。</p>
|
||||
<p>如果还是不行，请参考 文档 -> 内网部署 -> <a href="https://yapi.ymfe.org/devops.html#方式二. 命令行部署" >命令行部署</a> 文档</p>
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
@ -160,7 +160,7 @@ git clone https<span class="token operator">:</span>//github.com/YMFE/yapi.git v
|
||||
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
|
||||
cd vendors
|
||||
npm install
|
||||
node run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
|
||||
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
|
||||
npm run dev //启动服务器后，请访问 <span class="token number">127.0</span>.<span class="token number">0.1</span><span class="token operator">:</span><span class="token punctuation">{</span>config.json配置的端口<span class="token punctuation">}</span>，初次运行会有个编译的过程，请耐心等候
|
||||
</code></pre><h2 class="subject" id="安装成功后的目录结构">安装成功后的目录结构 <a class="hashlink" href="#安装成功后的目录结构">#</a></h2><pre><code>yapi
|
||||
config.json //服务器配置，可参考 vendors/config_example.json
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -180,4 +180,14 @@ body, h1, h2, h3, h4, h5, h6 {
|
||||
|
||||
.ydoc .ydoc-header .navbar-brand img{
|
||||
width: 32px;
|
||||
}
|
||||
|
||||
.ydoc .navbar-brand{
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.ydoc .ydoc-banner-home .home-btn:hover{
|
||||
background: #552d84;
|
||||
border: 1px solid;
|
||||
border-color: #fff;
|
||||
}
|
||||
@ -23,7 +23,7 @@
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YApi</a>
|
||||
<a href="./index.html" class="navbar-brand"><img src="./images/logo_header@2x.png" /> YAPI</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
|
||||
@ -8,7 +8,7 @@ module.exports = {
|
||||
"common": { // 通用默认配置，包括主页配置等
|
||||
"title": "YApi 接口管理平台", //page title
|
||||
"footer": "© 2017 <a href=\"https://github.com/ymfe\">YMFE</a> Team. Build by <a href=\"http://ued.qunar.com/ydoc/\">ydoc</a> ", // 通用尾
|
||||
"home": '<img src="./images/logo_header@2x.png" /> YApi', // logo
|
||||
"home": '<img src="./images/logo_header@2x.png" /> YAPI', // logo
|
||||
"homeUrl": "./index.html" // logourl
|
||||
},
|
||||
"options": {
|
||||
@ -39,15 +39,15 @@ module.exports = {
|
||||
"type": "thumbnail", // 三列布局的介绍板块
|
||||
"content": [{ // 三列布局的内容，每项的key值非必需，但建议每列的key值一致
|
||||
"name": "项目管理", // 板块名称
|
||||
"src": "http://ojk406wln.bkt.clouddn.com/intro_muti.png", // 缩略图
|
||||
"src": "./images/intro_page_1.png", // 缩略图
|
||||
"desc": "YApi 成熟的团队管理<br>扁平化项目权限配置满足各类企业的需求" // 描述
|
||||
},{
|
||||
"name": "接口管理",
|
||||
"src": "http://ojk406wln.bkt.clouddn.com/intro_md.png",
|
||||
"src": "./images/intro_page_2.png",
|
||||
"desc": "友好的接口文档<br>基于 websocket 的多人协作接口编辑功能和类 postman 测试工具，让多人协作成倍提升开发效率"
|
||||
},{
|
||||
"name": "MockServer",
|
||||
"src": "http://ojk406wln.bkt.clouddn.com/intro_theme.png",
|
||||
"src": "./images/intro_page_3.png",
|
||||
"desc": "基于 Mockjs<br>使用简单功能强大"
|
||||
}]
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user