api-template.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361
  1. <!DOCTYPE html>
  2. <html lang="zh-CN">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>${appdoc.appName}接口说明文档</title>
  6. <link href="/api/bootstrap.min.css" rel="stylesheet">
  7. <!--<link href="https://cdn.bootcss.com/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet">-->
  8. <link href="https://cdn.staticfile.org/prettify/r298/prettify.min.css" rel="stylesheet">
  9. <script src="/api/jquery.min.js"></script>
  10. <script src="/api/bootstrap.min.js"></script>
  11. <!--<script src="https://cdn.bootcss.com/highlight.js/9.12.0/highlight.min.js"></script>-->
  12. <script src="https://cdn.staticfile.org/prettify/r298/prettify.min.js"></script>
  13. <style type="text/css">
  14. body {
  15. padding-top: 50px;
  16. }
  17. .sub-header {
  18. padding-bottom: 10px;
  19. border-bottom: 1px solid #eee;
  20. }
  21. /*
  22. * Top navigation
  23. * Hide default border to remove 1px line.
  24. */
  25. .navbar-fixed-top {
  26. border: 0;
  27. }
  28. /*
  29. * Sidebar
  30. */
  31. /* Hide for mobile, show later */
  32. .sidebar {
  33. display: none;
  34. }
  35. @media (min-width: 768px) {
  36. .sidebar {
  37. position: fixed;
  38. top: 51px;
  39. bottom: 0;
  40. left: 0;
  41. z-index: 1000;
  42. display: block;
  43. padding: 20px;
  44. overflow-x: hidden;
  45. overflow-y: auto; /* Scrollable contents if viewport is shorter than content. */
  46. background-color: #f5f5f5;
  47. border-right: 1px solid #eee;
  48. }
  49. }
  50. /* Sidebar navigation */
  51. .nav-sidebar {
  52. margin-right: 5px; /* 20px padding + 1px border */
  53. margin-bottom: 20px;
  54. margin-left: 5px;
  55. margin-top: 5px;
  56. }
  57. .nav-sidebar > li > a {
  58. padding-right: 20px;
  59. padding-left: 20px;
  60. }
  61. .nav-sidebar > .active > a,
  62. .nav-sidebar > .active > a:hover,
  63. .nav-sidebar > .active > a:focus {
  64. color: #fff;
  65. background-color: #428bca;
  66. }
  67. /*
  68. * Main content
  69. */
  70. .main {
  71. padding: 20px;
  72. }
  73. @media (min-width: 768px) {
  74. .main {
  75. padding-right: 40px;
  76. padding-left: 40px;
  77. }
  78. }
  79. .main .page-header {
  80. margin-top: 0;
  81. }
  82. /*
  83. * Placeholder dashboard ideas
  84. */
  85. .placeholders {
  86. margin-bottom: 30px;
  87. text-align: center;
  88. }
  89. .placeholders h4 {
  90. margin-bottom: 0;
  91. }
  92. .placeholder {
  93. margin-bottom: 20px;
  94. }
  95. .placeholder img {
  96. display: inline-block;
  97. border-radius: 50%;
  98. }
  99. .linenums li {
  100. list-style-type: decimal !important;
  101. }
  102. </style>
  103. <!--<script>hljs.initHighlightingOnLoad();</script>-->
  104. </head>
  105. <body onload="prettyPrint()">
  106. <nav class="navbar navbar-inverse navbar-fixed-top">
  107. <div class="container-fluid">
  108. <div class="navbar-header">
  109. <a class="navbar-brand" href="#">${appdoc.appName}接口说明文档</a>
  110. </div>
  111. </div>
  112. </nav>
  113. <div class="container-fluid">
  114. <div class="row">
  115. <div class="col-sm-3 col-md-2 sidebar">
  116. <%
  117. var panelModuleHeadId;
  118. var panelModuleHeadIndex = 0;
  119. var panelModuleCollapseId;
  120. var panelModuleCollapseIndex = 0;
  121. var moduleList = appdoc.moduleList;
  122. var moduleLeftIndex = 0;
  123. for (appmodule in moduleList) {
  124. panelModuleHeadId = "panelModuleHead" + panelModuleHeadIndex;
  125. panelModuleCollapseId = "panelModuleCollapse" + panelModuleHeadIndex;
  126. %>
  127. <div class="panel-group" role="tablist">
  128. <div class="panel panel-default">
  129. <div class="panel-heading" role="tab" id="${panelModuleHeadId}">
  130. <h4 class="panel-title">
  131. <a class="" role="button" data-toggle="collapse" href="#${panelModuleCollapseId}"
  132. aria-expanded="false" aria-controls="${panelModuleCollapseId}">
  133. ${appmodule.moduleName}
  134. <span class="badge">${appmodule.methodList.~size}</span>
  135. </a>
  136. </h4>
  137. </div>
  138. <div id="${panelModuleCollapseId}" class="panel-collapse collapse in" role="tabpanel"
  139. aria-labelledby="${panelModuleHeadId}" aria-expanded="false" style="">
  140. <ul class="nav nav-sidebar">
  141. <%
  142. var methodList = appmodule.methodList;
  143. var methodLeftIndex = 0;
  144. for (appmethod in methodList) {
  145. %>
  146. <li><a href="#" moduleindex="${moduleLeftIndex}" methodindex="${methodLeftIndex}"
  147. onclick="viewMethodDetail(this)">${appmethod.methodName}</a></li>
  148. <%
  149. methodLeftIndex++;
  150. }
  151. %>
  152. </ul>
  153. </div>
  154. </div>
  155. </div>
  156. <%
  157. moduleLeftIndex++;
  158. panelModuleHeadIndex++;
  159. panelModuleHeadIndex++;
  160. }
  161. %>
  162. </div>
  163. <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
  164. <h1 class="page-header">函数说明</h1>
  165. <%
  166. var moduleIndex = 0;
  167. //var moduleList = appdoc.moduleList;
  168. for (appmodule in moduleList) {
  169. var methodList = appmodule.methodList;
  170. var methodIndex = 0;
  171. for (appmethod in methodList) {
  172. var moduleMethodPanelGroupId = "viewModuleMethodPanel-" + moduleIndex + "-" + methodIndex;
  173. %>
  174. <div class="panel panel-default" id="${moduleMethodPanelGroupId}" style="display: none;">
  175. <div class="panel-heading">
  176. <h4 class="panel-title">
  177. ${appmethod.methodName} <% if (appmethod.callFlag == 1) { %> (Call InvokeCallParams方法) <% } %>
  178. </h4>
  179. </div>
  180. <div class="panel-body">
  181. <p><h4><span class="label label-primary">接口地址:${appmethod.url}</span></h4></p>
  182. <p><h4><span class="label label-success">调用方法:${appmethod.supportMethods}</span></h4></p>
  183. <p><h4><span class="label label-info">接口返回:${appmethod.result}</span></h4></p>
  184. <p><h4><span class="label label-warning">是否鉴权:${appmethod.auth}</span></h4></p>
  185. <p><h4><span class="label label-default">参数<span
  186. class="badge">${appmethod.paramList.~size}</span></span></h4></p>
  187. <div class="table-responsive">
  188. <table class="table table-striped">
  189. <thead>
  190. <tr>
  191. <th>参数名称</th>
  192. <th>参数描述</th>
  193. <th>参数类型</th>
  194. <th>来源</th>
  195. <th>是否必须</th>
  196. </tr>
  197. </thead>
  198. <tbody>
  199. <%
  200. for (methodParam in appmethod.paramList) {
  201. %>
  202. <tr>
  203. <td>${methodParam.paramName}</td>
  204. <td>${methodParam.paramComment}</td>
  205. <td>${methodParam.paramType}</td>
  206. <td>${methodParam.paramSrc}</td>
  207. <td>${methodParam.paramRequired}</td>
  208. </tr>
  209. <%
  210. }
  211. %>
  212. </tbody>
  213. </table>
  214. </div>
  215. <p><h4><span class="label label-success">参数params的json说明</span></h4></p>
  216. <div class="table-responsive">
  217. <table class="table table-striped">
  218. <thead>
  219. <tr>
  220. <th>参数名称</th>
  221. <th>参数描述</th>
  222. <th>参数类型</th>
  223. <th>来源</th>
  224. <th>是否必须</th>
  225. </tr>
  226. </thead>
  227. <tbody>
  228. <%
  229. for (callParam in appmethod.callParamList) {
  230. %>
  231. <tr>
  232. <td>${callParam.paramName}</td>
  233. <td>${callParam.paramComment}</td>
  234. <td>${callParam.paramType}</td>
  235. <td>${callParam.paramSrc}</td>
  236. <td>${callParam.paramRequired}</td>
  237. </tr>
  238. <%
  239. }
  240. %>
  241. </tbody>
  242. </table>
  243. </div>
  244. <p><h4><span class="label label-default">示例代码【apis表示nginx的反向代理路径,按配置替换;如果函数返回的直接字符串,请修改datatype为String、Script、XML等】</span></h4></p>
  245. <!--<div class="table-responsive">-->
  246. <pre class="prettyprint linenums">
  247. <%
  248. for (demo in appmethod.demoJquery) {
  249. %>
  250. ${demo}
  251. <%
  252. }
  253. %>
  254. </pre>
  255. <p><h4><span class="label label-default">类型<span
  256. class="badge">${appmethod.classList.~size}</span></span></h4></p>
  257. <%
  258. for (methodClass in appmethod.classList) {
  259. %>
  260. <p><h4><span class="label label-danger">${methodClass.className}<% if (methodClass.result) { %><b>[返回对象]</b><% } %><b>[蓝色表示此接口需要的属性]</b></span></h4></p>
  261. <div class="table-responsive">
  262. <table class="table table-striped">
  263. <thead>
  264. <tr>
  265. <th>属性名称</th>
  266. <th>属性描述</th>
  267. <th>服务接口</th>
  268. </tr>
  269. </thead>
  270. <tbody>
  271. <%
  272. for (field in methodClass.classField) {
  273. %>
  274. <tr>
  275. <%
  276. if (field.fieldCurrent == 1) {
  277. %>
  278. <td class="text-primary">
  279. <b>${field.fieldName}</b>
  280. <% } else { %>
  281. <td>
  282. ${field.fieldName}
  283. <% } %>
  284. </td>
  285. <td>
  286. ${field.fieldComment}
  287. </td>
  288. <td>
  289. <%
  290. for (place in field.fieldPlace) {
  291. %>
  292. ${place}
  293. <br>
  294. <%
  295. }
  296. %>
  297. </td>
  298. </tr>
  299. <%
  300. }
  301. %>
  302. </tbody>
  303. </table>
  304. </div>
  305. <%
  306. }
  307. %>
  308. </div>
  309. </div>
  310. <%
  311. methodIndex++;
  312. }
  313. moduleIndex++;
  314. }
  315. %>
  316. </div>
  317. </div>
  318. </div>
  319. <script>
  320. function viewMethodDetail(e) {
  321. var moduleIndex = $(e).attr("moduleindex");
  322. var methodIndex = $(e).attr("methodindex");
  323. var methodDoc = "viewModuleMethodPanel-" + moduleIndex + "-" + methodIndex;
  324. var $methodPanel = $("#" + methodDoc);
  325. $methodPanel.siblings(".panel").hide();
  326. $methodPanel.show();
  327. }
  328. </script>
  329. </body>
  330. </html>