410 lines
18 KiB
HTML
410 lines
18 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
<!--无论发布在哪、如何修改源码，请勿删除本行原作者信息，感谢-->
|
||
<meta name="author" content="开发者列表：暮光：城中城，项目地址：https://gitee.com/zyplayer/zyplayer-doc" />
|
||
<title>接口文档管理系统</title>
|
||
<link rel="shortcut icon" href="webjars/mg-ui/img/api.ico"/>
|
||
<link rel="stylesheet" href="webjars/zui/css/zui.min.css" />
|
||
<link rel="stylesheet" href="webjars/zui/lib/dashboard/zui.dashboard.min.css" />
|
||
<link rel="stylesheet" href="webjars/zui/lib/tabs/zui.tabs.min.css" />
|
||
<link rel="stylesheet" href="webjars/mg-ui/css/mg-ui.css" />
|
||
</head>
|
||
<body>
|
||
<div class="left-body" id="leftContent">
|
||
<div class="left-header">
|
||
<span class="logo" id="logoText">zyplayer-doc-swagger</span>
|
||
<i class="icon icon-bars" id="changeContentWidth"></i>
|
||
</div>
|
||
<div class="scrollbar-hover left-container">
|
||
<div class="btn-group choice-location-list" id="choiceLocationList">
|
||
<button type="button" class="btn btn-primary dropdown-toggle" data-toggle="dropdown">
|
||
<span class="choice-text"></span> <span class="caret"></span>
|
||
</button>
|
||
<ul class="dropdown-menu" role="menu"></ul>
|
||
</div>
|
||
<!-- 样式类可选：tree-menu tree-folders tree-chevrons tree-angles -->
|
||
<ul class="tree tree-lines tree-menu projects" data-ride="tree">
|
||
<li>
|
||
<div class="input-group">
|
||
<input type="text" class="form-control" id="searchDocInput">
|
||
<span class="input-group-btn">
|
||
<button class="btn btn-default" type="button" id="searchDocBt">搜索</button>
|
||
</span>
|
||
</div>
|
||
</li>
|
||
<li id="homePageLi"><a href="javascript:void(0)" path=""><i class="icon-home"></i> 控制台</a></li>
|
||
<li id="tabZpagesNavigationUl">
|
||
<a href="#"><i class="icon icon-cogs"></i> 文档管理</a>
|
||
<ul>
|
||
<li id="onlineDebugLi1" class="local-storage"><a href="javascript:void(0)" path=""><i class="icon-bug"></i> 在线调试管理</a></li>
|
||
<li><a href="#" class="page-nav" data-id="docShowConfig" data-href="webjars/zpages/docShowConfig.html" data-icon="icon-cog" data-reload="0"><i class="icon-cog"></i> 文档展示配置</a></li>
|
||
<li><a href="#" class="page-nav" data-id="docUrlConfig" data-href="webjars/zpages/docUrlConfig.html" data-icon="icon-list" data-reload="1"><i class="icon-list"></i> 文档地址管理</a></li>
|
||
<li><a href="#" class="page-nav" data-id="docUrlDetailConfig" data-href="webjars/zpages/docUrlDetailConfig.html" data-icon="icon-list-alt" data-reload="1"><i class="icon-list-alt"></i> 详细地址管理</a></li>
|
||
<li><a href="#" class="page-nav" data-id="globalParamConfig" data-href="webjars/zpages/globalParamConfig.html" data-icon="icon-globe" data-reload="1"><i class="icon-globe"></i> 全局参数管理</a></li>
|
||
<li><a href="#" class="page-nav" data-id="debugDataConfig" data-href="webjars/zpages/debugDataConfig.html" data-icon="icon-bug" data-reload="1"><i class="icon-bug"></i> 调试数据管理</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<div id="apiPathTree">
|
||
<ul class="tree tree-lines projects"></ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="resizableLeftRight" class="ui-resizable-handle mgresizableW"></div>
|
||
<div class="right-container" id="rightContent">
|
||
<div class="right-container" id="rightContentMask"></div>
|
||
<div class="tab-page tab-home-page">
|
||
<div id="homePageDashboard">
|
||
<div class="dashboard" data-height="320"></div>
|
||
</div>
|
||
<div id="homePageDashboardTemplate" class="hidden">
|
||
<section class="row">
|
||
<div class="col-md-6 col-sm-6">
|
||
<div class="panel" data-id="1">
|
||
<div class="panel-heading">
|
||
<div class="title">工具介绍</div>
|
||
</div>
|
||
<div class="panel-body">
|
||
<div class="content about">
|
||
zyplayer-doc-swagger是swagger文档的管理工具，使用简单、解析速度快、走心的设计，
|
||
支持多项目同时展示，多种文档目录的展示方案，多种自定义配置，满足各种使用习惯。
|
||
本项目是完全从头写的，所以有任何属性未解析到、UI上有何建议都能及时处理得到。
|
||
使用中您有任何的意见和建议都可到源码地址处反馈哦！<br/>
|
||
源码地址：<a target="_blank" href="https://gitee.com/zyplayer/zyplayer-doc">zyplayer-doc-swagger</a>（还有其他很多功能哦），
|
||
前端框架：<a target="_blank" href="http://zui.sexy">zui</a>（很不错），
|
||
我的网站：<a target="_blank" href="http://kongjianzhou.com">空间轴</a>、<a target="_blank" href="http://zyplayer.com">自由发挥</a>（都已很久未维护）<br/>
|
||
<div id="upgradeInfoBox"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="tab-page tab-zpages hide">
|
||
<div class="tabs" id="rightZpages"></div>
|
||
</div>
|
||
<div class="tab-page tab-document hide">
|
||
<ul class="nav nav-tabs">
|
||
<li class="active"><a data-tab href="#tabDocInfo">接口说明</a></li>
|
||
<li><a data-tab href="#tabOnlineDebug">在线调试</a></li>
|
||
<li><a data-tab href="#tabSimulationResult">模拟返回</a></li>
|
||
</ul>
|
||
<div class="tab-content">
|
||
<div class="tab-pane tab-document-pane active" id="tabDocInfo">
|
||
<table class="table table-bordered doc-table">
|
||
<tr>
|
||
<td class="info">接口地址</td>
|
||
<td><span id="docUrl" class="label label-warning"></span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="info">说明</td>
|
||
<td id="docInfo"></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="info">请求方式</td>
|
||
<td><span id="docRequestMethod" class="label label-warning"></span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="info">consumes</td>
|
||
<td><span id="docConsumes" class="label label-warning"></span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="info">produces</td>
|
||
<td><span id="docProduces" class="label label-warning"></span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="info">test</td>
|
||
<td><div id="htmlStrTemp"></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="info">请求参数</td>
|
||
<td>
|
||
<ul class="nav nav-secondary gray">
|
||
<li class="active"><a data-tab href="#docRequestParam">说明</a></li>
|
||
<li><a data-tab href="#docRequestExample">例子</a></li>
|
||
</ul>
|
||
<div class="tab-content">
|
||
<div class="tab-pane tab-param-type-pane active" id="docRequestParam">
|
||
<table class="table table-bordered table-condensed">
|
||
<thead>
|
||
<tr><th>参数名</th><th>说明</th><th>类型</th><th>参数位置</th><th>是否必填</th></tr>
|
||
</thead>
|
||
<tbody></tbody>
|
||
</table>
|
||
</div>
|
||
<div class="tab-pane tab-param-type-pane" id="docRequestExample">
|
||
<table class="table table-bordered table-condensed">
|
||
<thead>
|
||
<tr><th>参数名</th><th>说明</th><th>类型</th><th>参数位置</th><th>是否必填</th></tr>
|
||
</thead>
|
||
<tbody></tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="info">响应Model</td>
|
||
<td>
|
||
<ul class="nav nav-secondary gray">
|
||
<li class="active"><a data-tab href="#docResponseModel">说明</a></li>
|
||
<li><a data-tab href="#docResponseExample">例子</a></li>
|
||
</ul>
|
||
<div class="tab-content">
|
||
<div class="tab-pane tab-param-type-pane active" id="docResponseModel">
|
||
<table class="table table-bordered">
|
||
<thead>
|
||
<tr><th>状态码</th><th>说明</th></tr>
|
||
</thead>
|
||
<tbody></tbody>
|
||
</table>
|
||
</div>
|
||
<div class="tab-pane tab-param-type-pane" id="docResponseExample">
|
||
<table class="table table-bordered">
|
||
<thead>
|
||
<tr><th>状态码</th><th>说明</th></tr>
|
||
</thead>
|
||
<tbody></tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="tab-pane tab-document-pane" id="tabOnlineDebug">
|
||
<div class="post-url-box">
|
||
<div class="input-group">
|
||
<!-- <div class="input-group-btn">
|
||
<button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
|
||
<span class="options">参数模板</span> <span class="caret"></span>
|
||
</button>
|
||
<ul class="dropdown-menu pull-left" role="menu">
|
||
<li><a href="javascript:void(0)">默认参数</a></li>
|
||
<li><a href="javascript:void(0);" class="save-request-template">+保存模板</a></li>
|
||
</ul>
|
||
</div> -->
|
||
<div class="input-group-btn" id="debugRequstType">
|
||
<button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
|
||
<span class="options">GET</span> <span class="caret"></span>
|
||
</button>
|
||
<ul class="dropdown-menu pull-left" role="menu">
|
||
<li><a href="javascript:void(0);">GET</a></li>
|
||
<li><a href="javascript:void(0);">POST</a></li>
|
||
<li><a href="javascript:void(0);">PUT</a></li>
|
||
<li><a href="javascript:void(0);">HEAD</a></li>
|
||
<li><a href="javascript:void(0);">PATCH</a></li>
|
||
<li><a href="javascript:void(0);">DELETE</a></li>
|
||
<li><a href="javascript:void(0);">OPTIONS</a></li>
|
||
<li><a href="javascript:void(0);">TRACE</a></li>
|
||
</ul>
|
||
</div>
|
||
<input type="text" class="form-control" id="postUrlInput" placeholder="请求的完整地址">
|
||
<span class="input-group-btn">
|
||
<button class="btn btn-default send-request" type="button">发送请求 <i class="icon icon-spin icon-spinner-snake hide"></i></button>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="param-response-box">
|
||
<div class="param-box">
|
||
<div class="panel panel-default">
|
||
<div class="panel-heading" id="headingOne">
|
||
<h4 class="panel-title">
|
||
<a data-toggle="collapse" href="#tabParamHeader">请求头</a>
|
||
<label class="overwrite-label"><input type="checkbox" id="bulkEditHeaderCheck" value="1"> 批量编辑</label>
|
||
</h4>
|
||
</div>
|
||
<div id="tabParamHeader" class="panel-collapse collapse in">
|
||
<form id="requestHeaderForm">
|
||
<table class="table table-bordered param-table">
|
||
<tbody>
|
||
<tr class="base">
|
||
<td><input type="text" class="form-control" name="paramName" placeholder=""></td>
|
||
<td><input type="text" class="form-control" name="paramValue" placeholder=""></td>
|
||
<td><i class="icon-times"></i></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<textarea class="hide form-control" id="bulkEditHeader" rows="6" placeholder="批量编辑请求头，使用英文冒号分隔，例： key:value key:value"></textarea>
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<div class="panel panel-default">
|
||
<div class="panel-heading">
|
||
<h4 class="panel-title">
|
||
<a data-toggle="collapse" href="#tabParamBody">请求参数</a>
|
||
</h4>
|
||
</div>
|
||
<div id="tabParamBody" class="panel-collapse collapse in">
|
||
<form id="requestParamForm">
|
||
<ul class="nav nav-secondary">
|
||
<li class="active"><a data-tab href="#tabParamTypeForm">表单</a></li>
|
||
<li><a data-tab href="#tabParamTypeBody">数据流</a></li>
|
||
<li class="form-to-url"><label><input type="checkbox" name="formToUrl" value="1"> 参数拼在URL后面发送</label></li>
|
||
<li class="form-to-url"><label><input type="checkbox" id="bulkEditFormCheck" value="1"> 批量编辑</label></li>
|
||
</ul>
|
||
<div class="tab-content">
|
||
<div class="tab-pane tab-param-type-pane active" id="tabParamTypeForm">
|
||
<table class="table table-bordered param-table">
|
||
<tbody>
|
||
<tr class="base">
|
||
<td><input type="text" class="form-control" name="paramName" placeholder=""></td>
|
||
<td><input type="text" class="form-control" name="paramValue" placeholder=""></td>
|
||
<td><i class="icon-times"></i></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<textarea class="hide form-control" id="bulkEditForm" rows="6" placeholder="批量编辑表单参数，使用英文冒号分隔，例： key:value key:value"></textarea>
|
||
</div>
|
||
<div class="tab-pane tab-param-type-pane" id="tabParamTypeBody">
|
||
<textarea class="form-control" name="paramBody" rows="6" placeholder=""></textarea>
|
||
</div>
|
||
</div>
|
||
</form>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="response-box">
|
||
<ul class="nav nav-secondary">
|
||
<li class="info"><span>结果集</span></li>
|
||
<li class="active"><a data-tab href="#tabResponseBody">Body</a></li>
|
||
<li class="local-storage"><a data-tab href="#tabResponseCookie">Cookie</a></li>
|
||
<li><a data-tab href="#tabResponseHeader">Header</a></li>
|
||
<li class="right"><span>状态：<i id="httpRequestStatus">200</i>，耗时：<i id="httpRequestTime">0ms</i></span></li>
|
||
</ul>
|
||
<div class="tab-content">
|
||
<div class="tab-pane tab-response-pane active" id="tabResponseBody">
|
||
<!-- <textarea class="form-control" id="responseBodyTextArea" rows="20" placeholder=""></textarea> -->
|
||
<div id="responseBodyJsonDiv"></div>
|
||
</div>
|
||
<div class="tab-pane tab-response-pane" id="tabResponseCookie">
|
||
<table class="table table-bordered param-table">
|
||
<thead>
|
||
<tr>
|
||
<th>名字</th>
|
||
<th>值</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody></tbody>
|
||
</table>
|
||
</div>
|
||
<div class="tab-pane tab-response-pane" id="tabResponseHeader">
|
||
<table class="table table-bordered param-table">
|
||
<thead>
|
||
<tr>
|
||
<th>名字</th>
|
||
<th>值</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody></tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="tab-pane tab-document-pane" id="tabSimulationResult">
|
||
<table class="table table-bordered doc-table">
|
||
<tr>
|
||
<td class="info">功能说明</td>
|
||
<td>
|
||
访问接口时增加参数：zyplayerApiTest=1，即可返回下面提交的模拟返回值<br/>
|
||
需要被访问项目增加<a href="https://gitee.com/zyplayer/zyplayer-doc/blob/master/zyplayer-doc-swagger/src/main/java/com/zyplayer/doc/swagger/framework/filter/ZyplayerApiTestFilter.java" target="_blank"> ZyplayerApiTestFilter.java</a>
|
||
过滤器才能使用，里面逻辑很简单，一看就懂~
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="info">接口地址</td>
|
||
<td><span id="simulationResultUrl" class="label label-warning"></span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="info">测试地址</td>
|
||
<td><a id="simulationResultUrlTest" href="" target="_blank"></a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="info">返回内容</td>
|
||
<td><textarea id="simulationResultText" class="form-control" rows="10"></textarea></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="info">操作</td>
|
||
<td>
|
||
<button type="button" class="btn btn-primary" id="simulationResultSubmit">提交模拟返回值</button>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<!-- 导出文档 -->
|
||
<div class="modal fade" id="exportDocumentModal">
|
||
<div class="modal-dialog">
|
||
<div class="modal-content">
|
||
<div class="modal-header">
|
||
<button type="button" class="close" data-dismiss="modal">
|
||
<span aria-hidden="true">×</span><span class="sr-only">关闭</span>
|
||
</button>
|
||
<h4 class="modal-title">导出文档</h4>
|
||
</div>
|
||
<div class="modal-body">
|
||
<div class="alert alert-danger hidden">
|
||
1、请到 <a target="_blank" href="https://gitee.com/zyplayer/zyplayer-doc">源码处下载</a>《对外文档模板.zip》解压<br/>
|
||
2、复制以下文本内容覆盖至 /js/mg-ui-data.js 文件内<br/>
|
||
3、然后双击打开目录下的：document.html 即可看到导出的文档
|
||
</div>
|
||
<div class="modal-table-box">
|
||
<ul id="exportDocumentUl" class="choise"></ul>
|
||
<textarea id="exportDocumentText" class="form-control hidden"></textarea>
|
||
</div>
|
||
<div align="center" class="bottom-box">
|
||
<button class="btn btn-primary" type="button" id="doExportBtn">确认导出</button>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<!-- 选择展示的项目 -->
|
||
<div class="modal fade" id="choiseDocModal">
|
||
<div class="modal-dialog">
|
||
<div class="modal-content">
|
||
<div class="modal-header">
|
||
<h4 class="modal-title">选择需要展示的文档</h4>
|
||
</div>
|
||
<div class="modal-body">
|
||
<div class="alert alert-danger">不选择则展示全部，展示接口过多会影响效率，建议只展示想看的文档</div>
|
||
<div class="modal-table-box">
|
||
<ul id="choiseDocListUl" class="choise"></ul>
|
||
</div>
|
||
<div align="center" class="bottom-box">
|
||
<button type="button" class="btn btn-primary" id="choiseDocBtn"> 确定 </button>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
<script type="text/javascript" src="webjars/mg-ui/js/jquery-3.1.0.min.js"></script>
|
||
<script type="text/javascript" src="webjars/zui/js/zui.min.js"></script>
|
||
<script type="text/javascript" src="webjars/zui/lib/tabs/zui.tabs.min.js"></script>
|
||
<script type="text/javascript" src="webjars/zui/lib/dashboard/zui.dashboard.min.js"></script>
|
||
|
||
<!--
|
||
<script type="text/javascript" src="webjars/mg-ui/js/mg-ui.min.js"></script>
|
||
-->
|
||
<script type="text/javascript" src="webjars/mg-ui/js/formatjson.js"></script>
|
||
<script type="text/javascript" src="webjars/mg-ui/js/toast.js"></script>
|
||
<script type="text/javascript" src="webjars/mg-ui/js/common.js"></script>
|
||
<script type="text/javascript" src="webjars/mg-ui/js/mgResizable.js"></script>
|
||
<script type="text/javascript" src="webjars/mg-ui/js/mg-ui-tree.js"></script>
|
||
<script type="text/javascript" src="webjars/mg-ui/js/mg-ui-tag.js"></script>
|
||
<script type="text/javascript" src="webjars/mg-ui/js/mg-ui-debug.js"></script>
|
||
<script type="text/javascript" src="webjars/mg-ui/js/mg-ui-export.js"></script>
|
||
<script type="text/javascript" src="webjars/mg-ui/js/mg-ui-cache-keys.js"></script>
|
||
<script type="text/javascript" src="webjars/mg-ui/js/mg-ui.js"></script>
|
||
</html>
|
||
|