这些数据建议，
1、先获取控制器列表、
2、获取方法名和注释信息并拆分出数组信息
3、将内容静态化
需要的数据格式
<?php
namespace app\index\controller;
use app\common\controller\Frontend;
class Index extends Frontend
{
protected $noNeedLogin = '*';
protected $noNeedRight = '*';
protected $layout = '';
public function index()
{
$docslist=[
"手机短信接口"=>[
[
"id"=>0,
"title"=>"发送验证码",
"summary"=>"发送验证码",
"method_label"=>"label-primary",
"method"=>"get",
"route"=>"/api/common/upload",
"summary"=>"总结",
"headerslist"=>[["name"=>"name","type"=>"name","required"=>"name","description"=>"name","sample"=>"sample"],["name"=>"name","type"=>"name","required"=>"name","description"=>"name","sample"=>"sample"]],
"paramslist"=>[["name"=>"name","route"=>"route","type"=>"name","required"=>"name","description"=>"name","sample"=>"sample"],["name"=>"name","route"=>"route","type"=>"name","required"=>"name","description"=>"name","sample"=>"sample"]],
"returnparamslist"=>[["name"=>"name","route"=>"route","type"=>"name","required"=>"required","description"=>"name","sample"=>"sample"],["name"=>"name","route"=>"route","type"=>"name","required"=>"name","description"=>"name","sample"=>"sample"]],
"body"=>"body"
], [
"id"=>0,
"title"=>"发送验证码",
"summary"=>"发送验证码",
"method_label"=>"label-primary",
"method"=>"get",
"route"=>"/api/common/upload",
"summary"=>"总结",
"headerslist"=>[["name"=>"name","type"=>"name","required"=>"required","description"=>"name","sample"=>"sample"],["name"=>"name","type"=>"name","required"=>"name","description"=>"name","sample"=>"sample"]],
"paramslist"=>[["name"=>"name","route"=>"route","type"=>"name","required"=>"required","description"=>"name","sample"=>"sample"],["name"=>"name","route"=>"route","type"=>"name","required"=>"name","description"=>"name","sample"=>"sample"]],
"returnparamslist"=>[["name"=>"name","route"=>"route","type"=>"name","required"=>"required","description"=>"name","sample"=>"sample"],["name"=>"name","route"=>"route","type"=>"name","required"=>"name","description"=>"name","sample"=>"sample"]],
"body"=>"body"
],
]
];
$this->view->assign('docslist', $docslist);
$this->view->assign('lang', $lang);
return $this->view->fetch();
}
}
thinkphp中的视图
<!DOCTYPE html>
<html>
<head>
{include file="common/meta" /}
<link href="__CDN__/assets/css/user.css?v={$Think.config.site.version}" rel="stylesheet">
<script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
<style type="text/css">
body {
padding-top: 70px; margin-bottom: 15px;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
font-family: "Roboto", "SF Pro SC", "SF Pro Display", "SF Pro Icons", "PingFang SC", BlinkMacSystemFont, -apple-system, "Segoe UI", "Microsoft Yahei", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", "Helvetica", "Arial", sans-serif;
font-weight: 400;
}
h2 { font-size: 1.6em; }
hr { margin-top: 10px; }
.tab-pane { padding-top: 10px; }
.mt0 { margin-top: 0px; }
.footer { font-size: 12px; color: #666; }
.label { display: inline-block; min-width: 65px; padding: 0.3em 0.6em 0.3em; }
.string { color: green; }
.number { color: darkorange; }
.boolean { color: blue; }
.null { color: magenta; }
.key { color: red; }
.popover { max-width: 400px; max-height: 400px; overflow-y: auto;}
.list-group.panel > .list-group-item {
}
.list-group-item:last-child {
border-radius:0;
}
h4.panel-title a {
font-weight:normal;
font-size:14px;
}
h4.panel-title a .text-muted {
font-size:12px;
font-weight:normal;
font-family: 'Verdana';
}
#sidebar {
width: 220px;
position: fixed;
margin-left: -240px;
overflow-y:auto;
}
#sidebar > .list-group {
margin-bottom:0;
}
#sidebar > .list-group > a{
text-indent:0;
}
#sidebar .child {
border:1px solid #ddd;
border-bottom:none;
}
#sidebar .child > a {
border:0;
}
#sidebar .list-group a.current {
background:#f5f5f5;
}
@media (max-width: 1620px){
#sidebar {
margin:0;
}
#accordion {
padding-left:235px;
}
}
@media (max-width: 768px){
#sidebar {
display: none;
}
#accordion {
padding-left:0px;
}
}
.label-primary {
background-color: #248aff;
}
</style>
</head>
<body >
<!-- Fixed navbar -->
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="./" target="_blank">接口文档</a>
</div>
<div class="navbar-collapse collapse">
<form class="navbar-form navbar-right">
<div class="form-group">
Token:
</div>
<div class="form-group">
<input type="text" class="form-control input-sm" data-toggle="tooltip" title="{{lang.Tokentips}}" placeholder="token" id="token" />
</div>
<div class="form-group">
Apiurl:
</div>
<div class="form-group">
<input id="apiUrl" type="text" class="form-control input-sm" data-toggle="tooltip" title="{{lang.Apiurltips}}" placeholder="https://api.mydomain.com" value=" " />
</div>
<div class="form-group">
<button type="button" class="btn btn-success btn-sm" data-toggle="tooltip" title="{{lang.Savetips}}" id="save_data">
<span class="glyphicon glyphicon-floppy-disk" aria-hidden="true"></span>
</button>
</div>
</form>
</div><!--/.nav-collapse -->
</div>
</div>
<div class="container" id="app">
<!-- 导航目录 -->
<div id="sidebar">
<div class="list-group panel">
{foreach name="docslist" id="docs"}
<a href="#{$key}" class="list-group-item" data-toggle="collapse" data-parent="#sidebar">{$key} <i class="fa fa-caret-down"></i></a>
<div class="child collapse" id="{$key}">
{foreach name="docs" id="api" }
<a href="javascript:;" data-id="{$api.id}" class="list-group-item">{$api.title}</a>
{/foreach}
</div>
{/foreach}
</div>
</div>
<div class="panel-group" id="accordion">
{foreach name="docslist" id="docs"}
<h2>{$key}</h2>
<hr>
{foreach name="docs" id="api" }
<div class="panel panel-default">
<div class="panel-heading" id="heading-{$api.id}">
<h4 class="panel-title">
<span class="label {$api.method_label}">{$api.method|strtoupper}</span>
<a data-toggle="collapse" data-parent="#accordion{$api.id}" href="#collapseOne{$api.id}"> {$api.title} <span class="text-muted">{$api.route}</span></a>
</h4>
</div>
<div id="collapseOne{$api.id}" class="panel-collapse collapse">
<div class="panel-body">
<!-- Nav tabs -->
<ul class="nav nav-tabs" id="doctab{$api.id}">
<li class="active"><a href="#info{$api.id}" data-toggle="tab">{{lang.Info}}</a></li>
<li><a href="#sandbox{$api.id}" data-toggle="tab">{{lang.Sandbox}}</a></li>
<li><a href="#sample{$api.id}" data-toggle="tab">{{lang.Sampleoutput}}</a></li>
</ul>
<!-- Tab panes -->
<div class="tab-content">
<div class="tab-pane active" id="info{$api.id}">
<div class="well">
{$api.summary}
</div>
<div class="panel panel-default">
<div class="panel-heading"><strong>{{lang.Headers}}</strong></div>
<div class="panel-body">
{if $api.headerslist}
<table class="table table-hover">
<thead>
<tr>
<th>{{lang.Name}}</th>
<th>{{lang.Type}}</th>
<th>{{lang.Required}}</th>
<th>{{lang.Description}}</th>
</tr>
</thead>
<tbody>
{foreach name="api['headerslist']" id="header"}
<tr>
<td>{$header.name}</td>
<td>{$header.type}</td>
<td>{$header.required?'是':'否'}</td>
<td>{$header.description}</td>
</tr>
{/foreach}
</tbody>
</table>
{else /}
无
{/if}
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><strong>{{lang.Parameters}}</strong></div>
<div class="panel-body">
{if $api.paramslist}
<table class="table table-hover">
<thead>
<tr>
<th>{{lang.Name}}</th>
<th>{{lang.Type}}</th>
<th>{{lang.Required}}</th>
<th>{{lang.Description}}</th>
</tr>
</thead>
<tbody>
{foreach name="api['paramslist']" id="param"}
<tr>
<td>{$param.name}</td>
<td>{$param.type}</td>
<td>{:$param.required?'是':'否'}</td>
<td>{$param.description}</td>
</tr>
{/foreach}
</tbody>
</table>
{else /}
无
{/if}
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><strong>{{lang.Body}}</strong></div>
<div class="panel-body">
{$api.body|default='无'}
</div>
</div>
</div><!-- #info -->
<div class="tab-pane" id="sandbox{$api.id}">
<div class="row">
<div class="col-md-12">
{if $api.headerslist}
<div class="panel panel-default">
<div class="panel-heading"><strong>{{lang.Headers}}</strong></div>
<div class="panel-body">
<div class="headers">
{foreach name="api['headerslist']" id="param"}
<div class="form-group">
<label class="control-label" for="{$param.name}">{$param.name}</label>
<input type="{$param.type}" class="form-control input-sm" id="{$param.name}" {if $param.required}required{/if} placeholder="{$param.description} - Ex: {$param.sample}" name="{$param.name}">
</div>
{/foreach}
</div>
</div>
</div>
{/if}
<div class="panel panel-default">
<div class="panel-heading"><strong>{{lang.Parameters}}</strong></div>
<div class="panel-body">
<form enctype="application/x-www-form-urlencoded" role="form" action="{$api.route}" method="{$api.method}" name="form{$api.id}" id="form{$api.id}">
{if $api.paramslist}
{foreach name="api['paramslist']" id="param"}
<div class="form-group">
<label class="control-label" for="{$param.name}">{$param.name}</label>
<input type="{$param.type}" class="form-control input-sm" id="{$param.name}" {if $param.required}required{/if} placeholder="{$param.description}{if $param.sample} - 例: {$param.sample}{/if}" name="{$param.name}">
</div>
{/foreach}
{else /}
<div class="form-group">
无
</div>
{/if}
<div class="form-group">
<button type="submit" class="btn btn-success send" rel="{$api.id}">{{lang.Send}}</button>
<button type="reset" class="btn btn-info" rel="{$api.id}">{{lang.Reset}}</button>
</div>
</form>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><strong>{{lang.Response}}</strong></div>
<div class="panel-body">
<div class="row">
<div class="col-md-12" style="overflow-x:auto">
<pre id="response_headers{$api.id}"></pre>
<pre id="response{$api.id}"></pre>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><strong>{{lang.ReturnParameters}}</strong></div>
<div class="panel-body">
{if $api.returnparamslist}
<table class="table table-hover">
<thead>
<tr>
<th>{{lang.Name}}</th>
<th>{{lang.Type}}</th>
<th>{{lang.Description}}</th>
</tr>
</thead>
<tbody>
{foreach name="api['returnparamslist']" id="param"}
<tr>
<td>{$param.name}</td>
<td>{$param.type}</td>
<td>{$param.description}</td>
</tr>
{/foreach}
</tbody>
</table>
{else /}
无
{/if}
</div>
</div>
</div>
</div>
</div><!-- #sandbox -->
<div class="tab-pane" id="sample{$api.id}">
<div class="row">
<div class="col-md-12">
<pre id="sample_response{$api.id}">{$api.return|default='无'}</pre>
</div>
</div>
</div><!-- #sample -->
</div><!-- .tab-content -->
</div>
</div>
</div>
{/foreach}
{/foreach}
</div>
<hr>
</div> <!-- /container -->
<!-- jQuery -->
<script src="https://cdn.staticfile.org/jquery/2.1.4/jquery.min.js"></script>
<!-- Bootstrap Core JavaScript -->
<script src="https://cdn.staticfile.org/twitter-bootstrap/3.3.7/js/bootstrap.min.js"></script>
<script type="text/javascript">
var app = new Vue({
el: '#app',
data: {
lang:{
"Tokentips": "Token 提示",
"Apiurltips": "Api url提示",
"Savetips": "保存提示",
"Info": "信息",
"Sandbox": "测试",
"Sampleoutput": "返回示例",
"Headers": "头部信息",
"Name": "名称",
"Type": "类型",
"Required": "必填",
"Description": "描述",
"Parameters": "参数设置",
"Body": "正文",
"Send": "提交",
"Reset": "重置",
"Response": "响应报文",
"ReturnParameters": "响应参数"
},
datalise:{
"手机短信接口": [
{
"id": 0,
"title": "发送验证码",
"summary": "总结",
"method_label": "label-primary",
"method": "get",
"route": "/api/common/upload",
"headerslist": [
{
"name": "name",
"type": "name",
"required": "name",
"description": "name",
"sample": "sample"
},
{
"name": "name",
"type": "name",
"required": "name",
"description": "name",
"sample": "sample"
}
],
"paramslist": [
{
"name": "name",
"route": "route",
"type": "name",
"required": "name",
"description": "name",
"sample": "sample"
},
{
"name": "name",
"route": "route",
"type": "name",
"required": "name",
"description": "name",
"sample": "sample"
}
],
"returnparamslist": [
{
"name": "name",
"route": "route",
"type": "name",
"required": "required",
"description": "name",
"sample": "sample"
},
{
"name": "name",
"route": "route",
"type": "name",
"required": "name",
"description": "name",
"sample": "sample"
}
],
"body": "body"
},
{
"id": 1,
"title": "发送验证1码",
"summary": "总结",
"method_label": "label-primary",
"method": "get",
"route": "/api/common/upload",
"headerslist": [
{
"name": "name",
"type": "name",
"required": "required",
"description": "name",
"sample": "sample"
},
{
"name": "name",
"type": "name",
"required": "name",
"description": "name",
"sample": "sample"
}
],
"paramslist": [
{
"name": "name",
"route": "route",
"type": "name",
"required": "required",
"description": "name",
"sample": "sample"
},
{
"name": "name",
"route": "route",
"type": "name",
"required": "name",
"description": "name",
"sample": "sample"
}
],
"returnparamslist": [
{
"name": "name",
"route": "route",
"type": "name",
"required": "required",
"description": "name",
"sample": "sample"
},
{
"name": "name",
"route": "route",
"type": "name",
"required": "name",
"description": "name",
"sample": "sample"
}
],
"body": "body"
}
]
}
}
})
//语法
function syntaxHighlight(json) {
if (typeof json != 'string') {
json = JSON.stringify(json, undefined, 2);
}
json = json.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>');
return json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g, function (match) {
var cls = 'number';
if (/^"/.test(match)) {
if (/:$/.test(match)) {
cls = 'key';
} else {
cls = 'string';
}
} else if (/true|false/.test(match)) {
cls = 'boolean';
} else if (/null/.test(match)) {
cls = 'null';
}
return '<span class="' + cls + '">' + match + '</span>';
});
}
//准备
function prepareStr(str) {
try {
return syntaxHighlight(JSON.stringify(JSON.parse(str.replace(/'/g, '"')), null, 2));
} catch (e) {
return str;
}
}
var storage = (function () {
var uid = new Date;
var storage;
var result;
try {
(storage = window.localStorage).setItem(uid, uid);
result = storage.getItem(uid) == uid;
storage.removeItem(uid);
return result && storage;
} catch (exception) {
}
}());
$.fn.serializeObject = function ()
{
var o = {};
var a = this.serializeArray();
$.each(a, function () {
if (!this.value) {
return;
}
if (o[this.name] !== undefined) {
if (!o[this.name].push) {
o[this.name] = [o[this.name]];
}
o[this.name].push(this.value || '');
} else {
o[this.name] = this.value || '';
}
});
return o;
};
$(document).ready(function () {
//获取设置的头部token和链接
if (storage) {
storage.getItem('token') && $('#token').val(storage.getItem('token'));
storage.getItem('apiUrl') && $('#apiUrl').val(storage.getItem('apiUrl'));
}
// //修改提示样式
$('[data-toggle="tooltip"]').tooltip({
placement: 'bottom'
});
//调整高度
$(window).on("resize", function(){
$("#sidebar").css("max-height", $(window).height()-80);
});
$(window).trigger("resize");
//点击侧边栏效果
$(document).on("click", "#sidebar .list-group > .list-group-item", function(){
$("#sidebar .list-group > .list-group-item").removeClass("current");
$(this).addClass("current");
});
//锚点跳转
$(document).on("click", "#sidebar .child a", function(){
var heading = $("#heading-"+$(this).data("id"));
if(!heading.next().hasClass("in")){
$("a", heading).trigger("click");
}
$("html,body").animate({scrollTop:heading.offset().top-70});
});
$('code[id^=response]').hide();
$.each($('pre[id^=sample_response],pre[id^=sample_post_body]'), function () {
if ($(this).html() == 'NA') {
return;
}
var str = prepareStr($(this).html());
$(this).html(str);
});
$("[data-toggle=popover]").popover({placement: 'right'});
//标签切换
$('[data-toggle=popover]').on('shown.bs.popover', function () {
var $sample = $(this).parent().find(".popover-content"),
str = $(this).data('content');
if (typeof str == "undefined" || str === "") {
return;
}
var str = prepareStr(str);
$sample.html('<pre>' + str + '</pre>');
});
///点击保存后Token和Api url都将保存在本地Localstorage中
$('body').on('click', '#save_data', function (e) {
if (storage) {
storage.setItem('token', $('#token').val());
storage.setItem('apiUrl', $('#apiUrl').val());
} else {
alert('Your browser does not support local storage');
}
});
//发布测试
$('body').on('click', '.send', function (e) {
e.preventDefault();
var form = $(this).closest('form');
//added /g to get all the matched params instead of only first
var matchedParamsInRoute = $(form).attr('action').match(/[^{]+(?=\})/g);
var theId = $(this).attr('rel');
//keep a copy of action attribute in order to modify the copy
//instead of the initial attribute
var url = $(form).attr('action');
var method = $(form).prop('method').toLowerCase() || 'get';
var formData = new FormData();
$(form).find('input').each(function (i, input) {
if ($(input).attr('type').toLowerCase() == 'file') {
formData.append($(input).attr('name'), $(input)[0].files[0]);
method = 'post';
} else {
formData.append($(input).attr('name'), $(input).val())
}
});
var index, key, value;
if (matchedParamsInRoute) {
var params = {};
formData.forEach(function(value, key){
params[key] = value;
});
for (index = 0; index < matchedParamsInRoute.length; ++index) {
try {
key = matchedParamsInRoute[index];
value = params[key];
if (typeof value == "undefined")
value = "";
url = url.replace("\{" + key + "\}", value);
formData.delete(key);
} catch (err) {
console.log(err);
}
}
}
var headers = {};
var token = $('#token').val();
if (token.length > 0) {
headers['token'] = token;
}
$("#sandbox" + theId + " .headers input[type=text]").each(function () {
val = $(this).val();
if (val.length > 0) {
headers[$(this).prop('name')] = val;
}
});
$.ajax({
url: $('#apiUrl').val() + url,
data: method == 'get' ? $(form).serialize() : formData,
type: method,
dataType: 'json',
contentType: false,
processData: false,
headers: headers,
xhrFields: {
withCredentials: true
},
success: function (data, textStatus, xhr) {
if (typeof data === 'object') {
var str = JSON.stringify(data, null, 2);
$('#response' + theId).html(syntaxHighlight(str));
} else {
$('#response' + theId).html(data || '');
}
$('#response_headers' + theId).html('HTTP ' + xhr.status + ' ' + xhr.statusText + '<br/><br/>' + xhr.getAllResponseHeaders());
$('#response' + theId).show();
},
error: function (xhr, textStatus, error) {
try {
var str = JSON.stringify($.parseJSON(xhr.responseText), null, 2);
} catch (e) {
var str = xhr.responseText;
}
$('#response_headers' + theId).html('HTTP ' + xhr.status + ' ' + xhr.statusText + '<br/><br/>' + xhr.getAllResponseHeaders());
$('#response' + theId).html(syntaxHighlight(str));
$('#response' + theId).show();
}
});
return false;
});
});
</script>
</body>
</html>
扫一扫
563
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
