mirror of
https://gitee.com/apiadmin/ApiAdmin.git
synced 2025-04-05 19:41:43 +08:00
modified 移植接口文档模块
This commit is contained in:
zhaoxiang
parent
9461427ede
commit
f521ac4547
@ -8,13 +8,13 @@
|
||||
namespace app\wiki\controller;
|
||||
|
||||
|
||||
use think\Config;
|
||||
use think\facade\Config;
|
||||
use think\Controller;
|
||||
use think\exception\HttpResponseException;
|
||||
use think\Request;
|
||||
use think\Response;
|
||||
use think\View as ViewTemplate;
|
||||
use think\Url;
|
||||
use think\facade\Request;
|
||||
use think\facade\Response;
|
||||
use think\facade\View as ViewTemplate;
|
||||
use think\facade\Url;
|
||||
|
||||
class Base extends Controller {
|
||||
|
||||
|
||||
@ -58,7 +58,7 @@ class Index extends Base {
|
||||
}
|
||||
}
|
||||
|
||||
$apiList = (new AdminList())->whereIn('hash', $this->appInfo['app_api_show'][$groupHash])->where(['groupHash' => $groupHash])->select();
|
||||
$apiList = (new AdminList())->whereIn('hash', $this->appInfo['app_api_show'][$groupHash])->where(['group_hash' => $groupHash])->select();
|
||||
$apiList = Tools::buildArrFromObj($apiList);
|
||||
$apiList = Tools::buildArrByNewKey($apiList, 'hash');
|
||||
|
||||
|
||||
@ -6,8 +6,8 @@
|
||||
<link href="https://cdnjs.cloudflare.com/ajax/libs/semantic-ui/2.2.11/semantic.min.css" rel="stylesheet">
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/semantic-ui/2.2.11/components/tab.min.js"></script>
|
||||
<link rel="stylesheet" href="__STATIC__/jsonFormater/jsonFormater.css">
|
||||
<script type="text/javascript" src="__STATIC__/jsonFormater/jsonFormater.js"></script>
|
||||
<link rel="stylesheet" href="/static/jsonFormater/jsonFormater.css">
|
||||
<script type="text/javascript" src="/static/jsonFormater/jsonFormater.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<br />
|
||||
@ -45,13 +45,13 @@
|
||||
</div>
|
||||
<div class="twelve wide column">
|
||||
<div class="ui floating message" id="detail" style="overflow: auto;">
|
||||
<h2 class='ui header'>接口唯一标识：<a target="_blank" href="{$http_type}{$_SERVER['HTTP_HOST']}/api/{$hash}">{$hash}</a>{if condition="$detail['isTest'] == 1"}（{$detail['apiClass']}）{/if}</h2><br />
|
||||
<h2 class='ui header'>接口唯一标识：<a target="_blank" href="{$http_type}{$_SERVER['HTTP_HOST']}/api/{$hash}">{$hash}</a>{if condition="$detail['is_test'] == 1"}（{$detail['api_class']}）{/if}</h2><br />
|
||||
<div class="ui raised segment">
|
||||
<span class="ui red ribbon large label">接口说明</span>
|
||||
{if condition="$detail['status'] eq 0 "}
|
||||
<span class='ui red label large'><i class="usb icon"></i>禁用</span>
|
||||
{else /}
|
||||
{if condition="$detail['isTest'] eq 1 "}
|
||||
{if condition="$detail['is_test'] eq 1 "}
|
||||
<span class='ui teal label large'><i class="usb icon"></i>测试</span>
|
||||
{else /}
|
||||
<span class='ui green label large'><i class="usb icon"></i>启用</span>
|
||||
@ -78,7 +78,7 @@
|
||||
<h3>公共请求参数</h3>
|
||||
<table class="ui orange celled striped table" >
|
||||
<thead>
|
||||
<tr><th>参数名字</th><th>类型</th><th width="70">是否必须</th><th>默认值</th><th width="30%">其他</th><th>说明</th></tr>
|
||||
<tr><th>参数名字</th><th>类型</th><th width="96">字段状态</th><th width="70">默认值</th><th width="30%">其他</th><th>说明</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
@ -92,32 +92,24 @@
|
||||
<tr>
|
||||
<td>access-token</td>
|
||||
<td>String</td>
|
||||
<td>{$detail['accessToken']==1?'<span class="ui green label">必填</span>':'<span class="ui red label">勿填</span>'}</td>
|
||||
<td>{$detail['access_token']==1?'<span class="ui green label">复杂认证</span>':'<span class="ui red label">简易认证</span>'}</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>APP认证秘钥【请在Header头里面传递】</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>user-token</td>
|
||||
<td>String</td>
|
||||
<td>{$detail['needLogin']==1?'<span class="ui green label">必填</span>':'<span class="ui red label">勿填</span>'}</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>用户认证秘钥【请在Header头里面传递】</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>请求参数</h3>
|
||||
<table class="ui red celled striped table" >
|
||||
<thead>
|
||||
<tr><th>参数名字</th><th>类型</th><th width="70">是否必须</th><th>默认值</th><th>其他</th><th>说明</th></tr>
|
||||
<tr><th>参数名字</th><th>类型</th><th width="80">是否必须</th><th>默认值</th><th>其他</th><th>说明</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{volist name="request" id="vo"}
|
||||
<tr>
|
||||
<td>{$vo['fieldName']}</td>
|
||||
<td>{$dataType[$vo['dataType']]}</td>
|
||||
<td>{$vo['isMust']==1?'<span class="ui green label">必填</span>':'<span class="ui teal label">可选</span>'}</td>
|
||||
<td>{$vo['field_name']}</td>
|
||||
<td>{$dataType[$vo['data_type']]}</td>
|
||||
<td>{$vo['is_must']==1?'<span class="ui green label">必填</span>':'<span class="ui teal label">可选</span>'}</td>
|
||||
<td>{$vo['default']}</td>
|
||||
<td>{$vo['range']}</td>
|
||||
<td>{$vo['info']}</td>
|
||||
@ -158,8 +150,8 @@
|
||||
<tbody>
|
||||
{volist name="response" id="vo"}
|
||||
<tr>
|
||||
<td>{$vo['showName']}</td>
|
||||
<td>{$dataType[$vo['dataType']]}</td>
|
||||
<td>{$vo['show_name']}</td>
|
||||
<td>{$dataType[$vo['data_type']]}</td>
|
||||
<td>{$vo['info']}</td>
|
||||
</tr>
|
||||
{/volist}
|
||||
@ -187,11 +179,11 @@
|
||||
isCollapsible: true,
|
||||
quoteKeys: true,
|
||||
tabSize: 2,
|
||||
imgCollapsed: "__STATIC__/jsonFormater/Collapsed.gif",
|
||||
imgExpanded: "__STATIC__/jsonFormater/Expanded.gif"
|
||||
imgCollapsed: "/static/jsonFormater/Collapsed.gif",
|
||||
imgExpanded: "/static/jsonFormater/Expanded.gif"
|
||||
};
|
||||
window.jf = new JsonFormater(options);
|
||||
jf.doFormat({$detail["returnStr"]});
|
||||
jf.doFormat({$detail["return_str"]});
|
||||
}();
|
||||
});
|
||||
$('.ui .vertical').css('max-height', $('#detail').outerHeight(true));
|
||||
|
||||
@ -39,7 +39,7 @@
|
||||
{$groupInfo[$key]['name']}
|
||||
</a>
|
||||
<a class="meta" href="{:url('/wiki/detail/' . $key)}">
|
||||
<span class="group" style="font-size: 0.8em;">{:date('Y-m-d', $groupInfo[$key]['updateTime'])}</span>
|
||||
<span class="group" style="font-size: 0.8em;">{$groupInfo[$key]['update_time']}</span>
|
||||
</a>
|
||||
<a class="description" style="display: block;font-size: 0.8em;" href="{:url('/wiki/detail/' . $key)}">
|
||||
{php}
|
||||
|
||||
2
public/static/.gitignore
vendored
2
public/static/.gitignore
vendored
@ -1,2 +0,0 @@
|
||||
*
|
||||
!.gitignore
|
||||
BIN
public/static/defaultImg.jpg
Normal file
BIN
public/static/defaultImg.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
public/static/jsonFormater/Collapsed.gif
Normal file
BIN
public/static/jsonFormater/Collapsed.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 215 B |
BIN
public/static/jsonFormater/Expanded.gif
Normal file
BIN
public/static/jsonFormater/Expanded.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 206 B |
35
public/static/jsonFormater/jsonFormater.css
Normal file
35
public/static/jsonFormater/jsonFormater.css
Normal file
@ -0,0 +1,35 @@
|
||||
@charset "utf-8";
|
||||
/* CSS Document */
|
||||
.jf-ObjectBrace {
|
||||
color: #00AA00;
|
||||
font-weight: bold;
|
||||
}
|
||||
.jf-ArrayBrace {
|
||||
color: #0033FF;
|
||||
font-weight: bold;
|
||||
}
|
||||
.jf-PropertyName {
|
||||
color: #CC0000;
|
||||
font-weight: bold;
|
||||
}
|
||||
.jf-String {
|
||||
color: #007777;
|
||||
}
|
||||
.jf-Number {
|
||||
color: #AA00AA;
|
||||
}
|
||||
.jf-Boolean {
|
||||
color: #0000FF;
|
||||
}
|
||||
.jf-Null {
|
||||
color: #0000FF;
|
||||
}
|
||||
.jf-Comma {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
}
|
||||
pre.jf-CodeContainer {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
text-align: left;
|
||||
}
|
||||
202
public/static/jsonFormater/jsonFormater.js
Normal file
202
public/static/jsonFormater/jsonFormater.js
Normal file
@ -0,0 +1,202 @@
|
||||
function JsonFormater(opt) {
|
||||
this.options = $.extend({
|
||||
dom: '',
|
||||
tabSize: 2,
|
||||
singleTab: " ",
|
||||
quoteKeys: true,
|
||||
imgCollapsed: "images/Collapsed.gif",
|
||||
imgExpanded: "images/Expanded.gif",
|
||||
isCollapsible: true
|
||||
}, opt || {});
|
||||
this.isFormated = false;
|
||||
this.obj = {
|
||||
_dateObj: new Date(),
|
||||
_regexpObj: new RegExp()
|
||||
};
|
||||
this.init();
|
||||
}
|
||||
JsonFormater.prototype = {
|
||||
init: function () {
|
||||
this.tab = this.multiplyString(this.options.tabSize, this.options.singleTab);
|
||||
this.bindEvent();
|
||||
},
|
||||
doFormat: function (json) {
|
||||
var html;
|
||||
var obj;
|
||||
try {
|
||||
if(typeof json == 'object'){
|
||||
obj = [json];
|
||||
}else{
|
||||
if (json == ""){
|
||||
json = "\"\"";
|
||||
}
|
||||
obj = eval("[" + json + "]");
|
||||
}
|
||||
html = this.ProcessObject(obj[0], 0, false, false, false);
|
||||
$(this.options.dom).addClass('jf-CodeContainer');
|
||||
$(this.options.dom).html(html);
|
||||
this.isFormated = true;
|
||||
} catch (e) {
|
||||
alert("JSON数据格式不正确:\n" + e.message);
|
||||
$(this.options.dom).html("");
|
||||
this.isFormated = false;
|
||||
}
|
||||
},
|
||||
bindEvent: function () {
|
||||
var that = this;
|
||||
$(this.options.dom).off('click','.imgToggle');
|
||||
$(this.options.dom).on('click', '.imgToggle', function () {
|
||||
if (that.isFormated == false) {
|
||||
return;
|
||||
}
|
||||
that.makeContentVisible($(this).parent().next(), !$(this).data('status'));
|
||||
});
|
||||
},
|
||||
expandAll: function () {
|
||||
if (this.isFormated == false) {
|
||||
return;
|
||||
}
|
||||
var that = this;
|
||||
this.traverseChildren($(this.options.dom), function(element){
|
||||
if(element.hasClass('jf-collapsible')){
|
||||
that.makeContentVisible(element, true);
|
||||
}
|
||||
}, 0);
|
||||
},
|
||||
collapseAll: function () {
|
||||
if (this.isFormated == false) {
|
||||
return;
|
||||
}
|
||||
var that = this;
|
||||
this.traverseChildren($(this.options.dom), function(element){
|
||||
if(element.hasClass('jf-collapsible')){
|
||||
that.makeContentVisible(element, false);
|
||||
}
|
||||
}, 0);
|
||||
},
|
||||
collapseLevel: function(level){
|
||||
if (this.isFormated == false) {
|
||||
return;
|
||||
}
|
||||
var that = this;
|
||||
this.traverseChildren($(this.options.dom), function(element, depth){
|
||||
if(element.hasClass('jf-collapsible')){
|
||||
if(depth >= level){
|
||||
that.makeContentVisible(element, false);
|
||||
}else{
|
||||
that.makeContentVisible(element, true);
|
||||
}
|
||||
}
|
||||
}, 0);
|
||||
|
||||
},
|
||||
isArray: function (obj) {
|
||||
return obj &&
|
||||
typeof obj === 'object' &&
|
||||
typeof obj.length === 'number' && !(obj.propertyIsEnumerable('length'));
|
||||
},
|
||||
getRow: function (indent, data, isPropertyContent) {
|
||||
var tabs = "";
|
||||
if (!isPropertyContent) {
|
||||
tabs = this.multiplyString(indent, this.tab);
|
||||
}
|
||||
if (data != null && data.length > 0 && data.charAt(data.length - 1) != "\n") {
|
||||
data = data + "\n";
|
||||
}
|
||||
return tabs + data;
|
||||
},
|
||||
formatLiteral: function (literal, quote, comma, indent, isArray, style) {
|
||||
if (typeof literal == 'string') {
|
||||
literal = literal.split("<").join("<").split(">").join(">");
|
||||
}
|
||||
var str = "<span class='jf-" + style + "'>" + quote + literal + quote + comma + "</span>";
|
||||
if (isArray) str = this.getRow(indent, str);
|
||||
return str;
|
||||
},
|
||||
formatFunction: function (indent, obj) {
|
||||
var tabs;
|
||||
var i;
|
||||
var funcStrArray = obj.toString().split("\n");
|
||||
var str = "";
|
||||
tabs = this.multiplyString(indent, this.tab);
|
||||
for (i = 0; i < funcStrArray.length; i++) {
|
||||
str += ((i == 0) ? "" : tabs) + funcStrArray[i] + "\n";
|
||||
}
|
||||
return str;
|
||||
},
|
||||
multiplyString: function (num, str) {
|
||||
var result = '';
|
||||
for (var i = 0; i < num; i++) {
|
||||
result += str;
|
||||
}
|
||||
return result;
|
||||
},
|
||||
traverseChildren: function (element, func, depth) {
|
||||
var length = element.children().length;
|
||||
for (var i = 0; i < length; i++) {
|
||||
this.traverseChildren(element.children().eq(i), func, depth + 1);
|
||||
}
|
||||
func(element, depth);
|
||||
},
|
||||
makeContentVisible : function(element, visible){
|
||||
var img = element.prev().find('img');
|
||||
if(visible){
|
||||
element.show();
|
||||
img.attr('src', this.options.imgExpanded);
|
||||
img.data('status', 1);
|
||||
}else{
|
||||
element.hide();
|
||||
img.attr('src', this.options.imgCollapsed);
|
||||
img.data('status', 0);
|
||||
}
|
||||
},
|
||||
ProcessObject: function (obj, indent, addComma, isArray, isPropertyContent) {
|
||||
var html = "";
|
||||
var comma = (addComma) ? "<span class='jf-Comma'>,</span> " : "";
|
||||
var type = typeof obj;
|
||||
var clpsHtml = "";
|
||||
var prop;
|
||||
if (this.isArray(obj)) {
|
||||
if (obj.length == 0) {
|
||||
html += this.getRow(indent, "<span class='jf-ArrayBrace'>[ ]</span>" + comma, isPropertyContent);
|
||||
} else {
|
||||
clpsHtml = this.options.isCollapsible ? "<span><img class='imgToggle' data-status='1' src='" + this.options.imgExpanded + "'/></span><span class='jf-collapsible'>" : "";
|
||||
html += this.getRow(indent, "<span class='jf-ArrayBrace'>[</span>" + clpsHtml, isPropertyContent);
|
||||
for (var i = 0; i < obj.length; i++) {
|
||||
html += this.ProcessObject(obj[i], indent + 1, i < (obj.length - 1), true, false);
|
||||
}
|
||||
clpsHtml = this.options.isCollapsible ? "</span>" : "";
|
||||
html += this.getRow(indent, clpsHtml + "<span class='jf-ArrayBrace'>]</span>" + comma);
|
||||
}
|
||||
} else if (type == 'object') {
|
||||
if (obj == null) {
|
||||
html += this.formatLiteral("null", "", comma, indent, isArray, "Null");
|
||||
} else {
|
||||
var numProps = 0;
|
||||
for (prop in obj) numProps++;
|
||||
if (numProps == 0) {
|
||||
html += this.getRow(indent, "<span class='jf-ObjectBrace'>{ }</span>" + comma, isPropertyContent);
|
||||
} else {
|
||||
clpsHtml = this.options.isCollapsible ? "<span><img class='imgToggle' data-status='1' src='" + this.options.imgExpanded + "'/></span><span class='jf-collapsible'>" : "";
|
||||
html += this.getRow(indent, "<span class='jf-ObjectBrace'>{</span>" + clpsHtml, isPropertyContent);
|
||||
var j = 0;
|
||||
for (prop in obj) {
|
||||
var quote = this.options.quoteKeys ? "\"" : "";
|
||||
html += this.getRow(indent + 1, "<span class='jf-PropertyName'>" + quote + prop + quote + "</span>: " + this.ProcessObject(obj[prop], indent + 1, ++j < numProps, false, true));
|
||||
}
|
||||
clpsHtml = this.options.isCollapsible ? "</span>" : "";
|
||||
html += this.getRow(indent, clpsHtml + "<span class='jf-ObjectBrace'>}</span>" + comma);
|
||||
}
|
||||
}
|
||||
} else if (type == 'number') {
|
||||
html += this.formatLiteral(obj, "", comma, indent, isArray, "Number");
|
||||
} else if (type == 'boolean') {
|
||||
html += this.formatLiteral(obj, "", comma, indent, isArray, "Boolean");
|
||||
}else if (type == 'undefined') {
|
||||
html += this.formatLiteral("undefined", "", comma, indent, isArray, "Null");
|
||||
} else {
|
||||
html += this.formatLiteral(obj.toString().split("\\").join("\\\\").split('"').join('\\"'), "\"", comma, indent, isArray, "String");
|
||||
}
|
||||
return html;
|
||||
}
|
||||
};
|
||||
38
route/wikiRoute.php
Normal file
38
route/wikiRoute.php
Normal file
@ -0,0 +1,38 @@
|
||||
<?php
|
||||
/**
|
||||
* wiki路由
|
||||
*/
|
||||
|
||||
return [
|
||||
'[wiki]' => [
|
||||
'login' => [
|
||||
'wiki/index/login',
|
||||
['method' => 'get']
|
||||
],
|
||||
'doLogin' => [
|
||||
'wiki/index/doLogin',
|
||||
['method' => 'post']
|
||||
],
|
||||
'index' => [
|
||||
'wiki/index/index',
|
||||
['method' => 'get']
|
||||
],
|
||||
'calculation' => [
|
||||
'wiki/index/calculation',
|
||||
['method' => 'get']
|
||||
],
|
||||
'errorCode' => [
|
||||
'wiki/index/errorCode',
|
||||
['method' => 'get']
|
||||
],
|
||||
'detail/:groupHash/[:hash]' => [
|
||||
'wiki/index/detail',
|
||||
['method' => 'get']
|
||||
],
|
||||
'logout' => [
|
||||
'wiki/index/logout',
|
||||
['method' => 'get']
|
||||
],
|
||||
'__miss__' => ['wiki/index/index'],
|
||||
],
|
||||
];
|
||||
Loading…
x
Reference in New Issue
Block a user