mirror/yapi
2
0
Fork 0
mirror of https://github.com/YMFE/yapi.git synced 2024-12-09 05:00:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

opti: docs

Browse Source
This commit is contained in:
suxiaoxin 2018-04-28 17:05:46 +08:00
parent 9ed6990911
commit 9b7dac8261
3 changed files with 32 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
static/doc/documents/CHANGELOG.html
View File

@ -10,6 +10,7 @@
</div></div><nav class="m-header-nav js-nav"><ul class="m-header-items"><li class="item active"><a class="href" href="index.html">教程</a></li><li class="item "><a class="href" href="../devops/index.html">内网部署</a></li></ul></nav><div id="js-nav-btn" class="m-header-btn ui-font-ydoc"></div></header><div class="m-content" id="js-content"><div id="markdown-body" class="m-content-container markdown-body"><h3 id="v1.3.13">v1.3.13</h3>
<ul>
<li>新增通过命令行导入 swagger 接口数据功能</li>
<li>接口请求设置新增异步处理特性</li>
</ul>
<h3 id="v1.3.12">v1.3.12</h3>
<h4>Feature</h4>

17
static/doc/documents/project.html
View File

@ -121,8 +121,25 @@
sha384 //&#x8F6C;&#x6362;&#x5B57;&#x7B26;&#x4E32;&#x4E3A; sha384 &#x7F16;&#x7801;
sha512 //&#x8F6C;&#x6362;&#x5B57;&#x7B26;&#x4E32;&#x4E3A; sha512 &#x7F16;&#x7801;
unbase64 //&#x8F6C;&#x6362; base64 &#x7F16;&#x7801;&#x4E3A;&#x5B57;&#x7B26;&#x4E32;
axios // axios &#x5E93;&#xFF0C;&#x53EF;&#x7528;&#x4E8E; api &#x8BF7;&#x6C42;&#xFF0C;&#x5B98;&#x7F51; https://github.com/axios/axios
}
</code></pre>
<h3 id="请求配置-异步处理（v1.3.13+支持）">异步处理（v1.3.13+支持）</h3>
<p>处理请求参数，或返回数据，可能还会涉及到异步处理，比如 ajax 请求，YApi 在 v1.3.13 版本支持了异步处理。</p>
<pre><code class="language-javascript">context<span class="token punctuation">.</span>promise <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Promise</span><span class="token punctuation">(</span><span class="token keyword">function</span><span class="token punctuation">(</span>resolve<span class="token punctuation">)</span><span class="token punctuation">{</span>
<span class="token keyword">var</span> api <span class="token operator">=</span> context<span class="token punctuation">.</span>utils<span class="token punctuation">.</span>axios<span class="token punctuation">.</span><span class="token keyword">get</span><span class="token punctuation">(</span><span class="token string">'http://yapi.local.qunar.com:3000/api/user/status'</span><span class="token punctuation">)</span>
api<span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token keyword">function</span><span class="token punctuation">(</span>result<span class="token punctuation">)</span><span class="token punctuation">{</span>
<span class="token comment">//...</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>result<span class="token punctuation">.</span>data<span class="token punctuation">)</span>
<span class="token function">resolve</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre>
<p>使用方法就是在 <code>context</code> 里面添加 <code>promise</code> 参数,并且返回一个 Promise，不熟悉 Promise 的童鞋可以查下相关用法，ajax 请求可以使用 <code>context.utils.axios</code> 库。</p>
<blockquote>
<p>处理完成后，不要忘记 <code>resolve()</code>，不然会一直处于挂起状态</p>
</blockquote>
<h2 id="token配置">token配置</h2>
<p>每个项目都有唯一的标识token，用户可以使用这个token值来请求项目的所有资源数据。目前用到的地方是接口的<a href="./case.html">自动化测试</a>，用户不需要登录就可以访问接口测试结果信息。</p>
<h2 id="项目克隆">项目克隆</h2>

18
static/doc/search_json.js
View File

@ -230,7 +230,12 @@ window.ydoc_plugin_search_json = {
{
"title": "工具函数",
"url": "/documents/project.html#请求配置-工具函数",
"content": "工具函数context.utils = { _ //underscore 函数,详细 API 查看官网 http://underscorejs.org/\n base64 //转换字符串为 base64 编码\n md5 //转换字符串为 md5 编码\n sha1 //转换字符串为 sha1 编码\n sha224 //转换字符串为 sha224 编码\n sha256 //转换字符串为 sha256 编码\n sha384 //转换字符串为 sha384 编码\n sha512 //转换字符串为 sha512 编码\n unbase64 //转换 base64 编码为字符串 \n}\n"
"content": "工具函数context.utils = { _ //underscore 函数,详细 API 查看官网 http://underscorejs.org/\n base64 //转换字符串为 base64 编码\n md5 //转换字符串为 md5 编码\n sha1 //转换字符串为 sha1 编码\n sha224 //转换字符串为 sha224 编码\n sha256 //转换字符串为 sha256 编码\n sha384 //转换字符串为 sha384 编码\n sha512 //转换字符串为 sha512 编码\n unbase64 //转换 base64 编码为字符串 \n axios // axios 库，可用于 api 请求，官网 https://github.com/axios/axios\n}\n"
},
{
"title": "异步处理（v1.3.13+支持）",
"url": "/documents/project.html#请求配置-异步处理（v1.3.13+支持）",
"content": "异步处理（v1.3.13+支持）处理请求参数，或返回数据，可能还会涉及到异步处理，比如 ajax 请求，YApi 在 v1.3.13 版本支持了异步处理。context.promise = new Promise(function(resolve){ var api = context.utils.axios.get('http://yapi.local.qunar.com:3000/api/user/status')\n api.then(function(result){\n //...\n console.log(result.data)\n resolve()\n })\n\n})\n使用方法就是在 context 里面添加 promise 参数,并且返回一个 Promise，不熟悉 Promise 的童鞋可以查下相关用法，ajax 请求可以使用 context.utils.axios 库。处理完成后，不要忘记 resolve()，不然会一直处于挂起状态\n"
},
{
"title": "token配置",
@ -302,7 +307,12 @@ window.ydoc_plugin_search_json = {
{
"title": "工具函数",
"url": "/documents/project.html#请求配置-工具函数",
"content": "工具函数context.utils = { _ //underscore 函数,详细 API 查看官网 http://underscorejs.org/\n base64 //转换字符串为 base64 编码\n md5 //转换字符串为 md5 编码\n sha1 //转换字符串为 sha1 编码\n sha224 //转换字符串为 sha224 编码\n sha256 //转换字符串为 sha256 编码\n sha384 //转换字符串为 sha384 编码\n sha512 //转换字符串为 sha512 编码\n unbase64 //转换 base64 编码为字符串 \n}\n"
"content": "工具函数context.utils = { _ //underscore 函数,详细 API 查看官网 http://underscorejs.org/\n base64 //转换字符串为 base64 编码\n md5 //转换字符串为 md5 编码\n sha1 //转换字符串为 sha1 编码\n sha224 //转换字符串为 sha224 编码\n sha256 //转换字符串为 sha256 编码\n sha384 //转换字符串为 sha384 编码\n sha512 //转换字符串为 sha512 编码\n unbase64 //转换 base64 编码为字符串 \n axios // axios 库，可用于 api 请求，官网 https://github.com/axios/axios\n}\n"
},
{
"title": "异步处理（v1.3.13+支持）",
"url": "/documents/project.html#请求配置-异步处理（v1.3.13+支持）",
"content": "异步处理（v1.3.13+支持）处理请求参数，或返回数据，可能还会涉及到异步处理，比如 ajax 请求，YApi 在 v1.3.13 版本支持了异步处理。context.promise = new Promise(function(resolve){ var api = context.utils.axios.get('http://yapi.local.qunar.com:3000/api/user/status')\n api.then(function(result){\n //...\n console.log(result.data)\n resolve()\n })\n\n})\n使用方法就是在 context 里面添加 promise 参数,并且返回一个 Promise，不熟悉 Promise 的童鞋可以查下相关用法，ajax 请求可以使用 context.utils.axios 库。处理完成后，不要忘记 resolve()，不然会一直处于挂起状态\n"
},
{
"title": "token配置",
@ -1152,7 +1162,7 @@ window.ydoc_plugin_search_json = {
{
"title": "v1.3.13",
"url": "/documents/CHANGELOG.html#v1.3.13",
"content": "v1.3.13新增通过命令行导入 swagger 接口数据功能\n"
"content": "v1.3.13新增通过命令行导入 swagger 接口数据功能\n接口请求设置新增异步处理特性\n"
},
{
"title": "v1.3.12",
@ -1284,7 +1294,7 @@ window.ydoc_plugin_search_json = {
{
"title": "v1.3.13",
"url": "/documents/CHANGELOG.html#v1.3.13",
"content": "v1.3.13新增通过命令行导入 swagger 接口数据功能\n"
"content": "v1.3.13新增通过命令行导入 swagger 接口数据功能\n接口请求设置新增异步处理特性\n"
},
{
"title": "v1.3.12",