صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
lyhzzz
/
4dkankan-center-manage
1
0
انشعاب 0
پرونده‌ها مشکلات 0 درخواست واکشی 0 ویکی
شاخه: master
شاخه‌ها تگ‌ها
4dkankan-cen...
/
doc
/
AppReleaseLog-API.html

AppReleaseLog-API.html 15 KB
لینک دائمی تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="zh-CN">
    3. 

  3. <head>
    4. 

  4.     <meta charset="UTF-8">
    5. 

  5.     <meta name="viewport" content="width=device-width, initial-scale=1.0">
    6. 

  6.     <title>应用发布日志 API 文档</title>
    7. 

  7.     <style>
    8. 

  8.         * { margin: 0; padding: 0; box-sizing: border-box; }
    9. 

  9.         body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif; background: #f5f7fa; color: #333; line-height: 1.6; }
    10. 

  10.         .container { max-width: 1100px; margin: 0 auto; padding: 30px 20px; }
    11. 

  11.         h1 { font-size: 28px; margin-bottom: 8px; color: #1a1a2e; }
    12. 

  12.         .subtitle { color: #666; font-size: 14px; margin-bottom: 30px; }
    13. 

  13.         .badge { display: inline-block; padding: 2px 10px; border-radius: 4px; font-size: 12px; font-weight: 600; margin-right: 6px; }
    14. 

  14.         .badge-post { background: #e8f5e9; color: #2e7d32; }
    15. 

  15.         .badge-get { background: #e3f2fd; color: #1565c0; }
    16. 

  16.         .api-card { background: #fff; border-radius: 8px; box-shadow: 0 1px 3px rgba(0,0,0,0.08); margin-bottom: 20px; overflow: hidden; }
    17. 

  17.         .api-header { padding: 16px 20px; border-bottom: 1px solid #eee; cursor: pointer; display: flex; align-items: center; justify-content: space-between; }
    18. 

  18.         .api-header:hover { background: #fafafa; }
    19. 

  19.         .api-title { font-size: 16px; font-weight: 600; }
    20. 

  20.         .api-path { font-family: 'SFMono-Regular', Consolas, 'Liberation Mono', Menlo, monospace; font-size: 13px; color: #666; }
    21. 

  21.         .api-body { padding: 20px; display: none; }
    22. 

  22.         .api-body.open { display: block; }
    23. 

  23.         .section-title { font-size: 14px; font-weight: 600; color: #555; margin: 16px 0 8px; border-left: 3px solid #4a90d9; padding-left: 8px; }
    24. 

  24.         .section-title:first-child { margin-top: 0; }
    25. 

  25.         table { width: 100%; border-collapse: collapse; margin-bottom: 12px; font-size: 13px; }
    26. 

  26.         th { background: #f0f4f8; text-align: left; padding: 8px 12px; font-weight: 600; border-bottom: 2px solid #d0d7de; }
    27. 

  27.         td { padding: 8px 12px; border-bottom: 1px solid #eee; vertical-align: top; }
    28. 

  28.         tr:hover td { background: #fafbfc; }
    29. 

  29.         .required { color: #e53935; font-weight: 600; }
    30. 

  30.         .optional { color: #999; }
    31. 

  31.         code { background: #f0f4f8; padding: 2px 6px; border-radius: 3px; font-family: 'SFMono-Regular', Consolas, 'Liberation Mono', Menlo, monospace; font-size: 12px; color: #d63384; }
    32. 

  32.         pre { background: #1e1e2e; color: #cdd6f4; padding: 16px; border-radius: 6px; overflow-x: auto; font-size: 12px; line-height: 1.5; }
    33. 

  33.         pre code { background: none; color: inherit; padding: 0; }
    34. 

  34.         .toggle-icon { font-size: 18px; color: #999; transition: transform 0.2s; }
    35. 

  35.         .toggle-icon.rotated { transform: rotate(180deg); }
    36. 

  36.         .note { background: #fff3e0; border-left: 3px solid #ff9800; padding: 8px 12px; border-radius: 0 4px 4px 0; font-size: 13px; margin-top: 8px; }
    37. 

  37.         .note b { color: #e65100; }
    38. 

  38.     </style>
    39. 

  39. </head>
    40. 

  40. <body>
    41. 

  41. <div class="container">
    42. 

  42.     <h1>应用发布日志 API 文档</h1>
    43. 

  43.     <p class="subtitle">Base URL: <code>/service/manage/appReleaseLog</code> &nbsp;|&nbsp; 数据表: <code>t_app_release_log</code></p>
    44. 

  44. 

  45.     <!-- ==================== 分页查询 ==================== -->
    46. 

  46.     <div class="api-card">
    47. 

  47.         <div class="api-header" onclick="toggle(this)">
    48. 

  48.             <div>
    49. 

  49.                 <span class="api-title">分页查询发布日志列表</span>
    50. 

  50.             </div>
    51. 

  51.             <div style="display:flex;align-items:center;gap:10px;">
    52. 

  52.                 <span class="api-path">POST /service/manage/appReleaseLog/pageList</span>
    53. 

  53.                 <span class="toggle-icon">▼</span>
    54. 

  54.             </div>
    55. 

  55.         </div>
    56. 

  56.         <div class="api-body">
    57. 

  57.             <div class="section-title">请求体 (JSON)</div>
    58. 

  58.             <table>
    59. 

  59.                 <tr><th>字段</th><th>类型</th><th>必填</th><th>说明</th></tr>
    60. 

  60.                 <tr><td><code>pageNum</code></td><td>int</td><td><span class="optional">否(默认1)</span></td><td>当前页码</td></tr>
    61. 

  61.                 <tr><td><code>pageSize</code></td><td>int</td><td><span class="optional">否(默认10)</span></td><td>每页条数</td></tr>
    62. 

  62.                 <tr><td><code>appCode</code></td><td>String</td><td><span class="optional">否</span></td><td>应用标识（精确匹配），如 local_server、client</td></tr>
    63. 

  63.                 <tr><td><code>envTag</code></td><td>String</td><td><span class="optional">否</span></td><td>环境标识（精确匹配）：cn, eur, jp, ga</td></tr>
    64. 

  64.                 <tr><td><code>version</code></td><td>String</td><td><span class="optional">否</span></td><td>版本号（模糊匹配）</td></tr>
    65. 

  65.                 <tr><td><code>publicTarget</code></td><td>String</td><td><span class="optional">否</span></td><td>发布目标（模糊匹配）</td></tr>
    66. 

  66.             </table>
    67. 

  67.             <div class="section-title">请求示例</div>
    68. 

  68.             <pre><code>{
    69. 

  69.   "pageNum": 1,
    70. 

  70.   "pageSize": 10,
    71. 

  71.   "appCode": "local_server",
    72. 

  72.   "envTag": "cn",
    73. 

  73.   "version": "1.0"
    74. 

  74. }</code></pre>
    75. 

  75.             <div class="section-title">响应示例</div>
    76. 

  76.             <pre><code>{
    77. 

  77.   "code": 200,
    78. 

  78.   "message": "成功",
    79. 

  79.   "success": true,
    80. 

  80.   "timestamp": 1724000000000,
    81. 

  81.   "data": {
    82. 

  82.     "pageNum": 1,
    83. 

  83.     "pageSize": 10,
    84. 

  84.     "total": 100,
    85. 

  85.     "list": [
    86. 

  86.       {
    87. 

  87.         "id": 1,
    88. 

  88.         "appCode": "local_server",
    89. 

  89.         "publicTarget": "生产环境",
    90. 

  90.         "version": "1.0.0",
    91. 

  91.         "packageTarget": "/data/build",
    92. 

  92.         "publicAddress": "https://xxx.com/release",
    93. 

  93.         "updateContent": "修复已知问题",
    94. 

  94.         "remark": "备注信息",
    95. 

  95.         "envTag": "cn",
    96. 

  96.         "publishIp": "192.168.1.100",
    97. 

  97.         "publishUser": 10001,
    98. 

  98.         "recStatus": "A",
    99. 

  99.         "createTime": "2026-08-18 10:00:00",
    100. 

  100.         "updateTime": "2026-08-18 10:00:00"
    101. 

  101.       }
    102. 

  102.     ]
    103. 

  103.   }
    104. 

  104. }</code></pre>
    105. 

  105.         </div>
    106. 

  106.     </div>
    107. 

  107. 

  108.     <!-- ==================== 新增 ==================== -->
    109. 

  109.     <div class="api-card">
    110. 

  110.         <div class="api-header" onclick="toggle(this)">
    111. 

  111.             <div>
    112. 

  112.                 <span class="api-title">新增发布日志</span>
    113. 

  113.             </div>
    114. 

  114.             <div style="display:flex;align-items:center;gap:10px;">
    115. 

  115.                 <span class="api-path">POST /service/manage/appReleaseLog/add</span>
    116. 

  116.                 <span class="toggle-icon">▼</span>
    117. 

  117.             </div>
    118. 

  118.         </div>
    119. 

  119.         <div class="api-body">
    120. 

  120.             <div class="note"><b>注意：</b>publishUser（发布人）和 publishIp（发布IP）由后端自动填充，无需前端传入。</div>
    121. 

  121.             <div class="section-title">请求体 (JSON)</div>
    122. 

  122.             <table>
    123. 

  123.                 <tr><th>字段</th><th>类型</th><th>必填</th><th>说明</th></tr>
    124. 

  124.                 <tr><td><code>appCode</code></td><td>String</td><td><span class="required">是</span></td><td>应用标识，如 local_server、client</td></tr>
    125. 

  125.                 <tr><td><code>publicTarget</code></td><td>String</td><td><span class="required">是</span></td><td>发布目标</td></tr>
    126. 

  126.                 <tr><td><code>version</code></td><td>String</td><td><span class="required">是</span></td><td>版本号</td></tr>
    127. 

  127.                 <tr><td><code>packageTarget</code></td><td>String</td><td><span class="optional">否</span></td><td>打包目录</td></tr>
    128. 

  128.                 <tr><td><code>publicAddress</code></td><td>String</td><td><span class="optional">否</span></td><td>发布地址</td></tr>
    129. 

  129.                 <tr><td><code>updateContent</code></td><td>String</td><td><span class="optional">否</span></td><td>发布内容</td></tr>
    130. 

  130.                 <tr><td><code>remark</code></td><td>String</td><td><span class="optional">否</span></td><td>备注</td></tr>
    131. 

  131.                 <tr><td><code>envTag</code></td><td>String</td><td><span class="optional">否</span></td><td>环境标识：cn, eur, jp, ga</td></tr>
    132. 

  132.             </table>
    133. 

  133.             <div class="section-title">请求示例</div>
    134. 

  134.             <pre><code>{
    135. 

  135.   "appCode": "local_server",
    136. 

  136.   "publicTarget": "生产环境",
    137. 

  137.   "version": "1.0.0",
    138. 

  138.   "packageTarget": "/data/build/v1",
    139. 

  139.   "publicAddress": "https://xxx.com/release/v1",
    140. 

  140.   "updateContent": "1. 修复登录问题\n2. 优化性能",
    141. 

  141.   "remark": "首次发布",
    142. 

  142.   "envTag": "cn"
    143. 

  143. }</code></pre>
    144. 

  144.             <div class="section-title">响应示例</div>
    145. 

  145.             <pre><code>{
    146. 

  146.   "code": 200,
    147. 

  147.   "message": "新增成功",
    148. 

  148.   "success": true,
    149. 

  149.   "timestamp": 1724000000000,
    150. 

  150.   "data": {
    151. 

  151.     "id": 1,
    152. 

  152.     "appCode": "local_server",
    153. 

  153.     "publishUser": 10001,
    154. 

  154.     "publishIp": "192.168.1.100",
    155. 

  155.     ...
    156. 

  156.   }
    157. 

  157. }</code></pre>
    158. 

  158.         </div>
    159. 

  159.     </div>
    160. 

  160. 

  161.     <!-- ==================== 更新 ==================== -->
    162. 

  162.     <div class="api-card">
    163. 

  163.         <div class="api-header" onclick="toggle(this)">
    164. 

  164.             <div>
    165. 

  165.                 <span class="api-title">更新发布日志</span>
    166. 

  166.             </div>
    167. 

  167.             <div style="display:flex;align-items:center;gap:10px;">
    168. 

  168.                 <span class="api-path">POST /service/manage/appReleaseLog/update</span>
    169. 

  169.                 <span class="toggle-icon">▼</span>
    170. 

  170.             </div>
    171. 

  171.         </div>
    172. 

  172.         <div class="api-body">
    173. 

  173.             <div class="section-title">请求体 (JSON)</div>
    174. 

  174.             <table>
    175. 

  175.                 <tr><th>字段</th><th>类型</th><th>必填</th><th>说明</th></tr>
    176. 

  176.                 <tr><td><code>id</code></td><td>Integer</td><td><span class="required">是</span></td><td>记录ID</td></tr>
    177. 

  177.                 <tr><td colspan="4" style="color:#999;font-style:italic;">其余字段按需传入，仅更新传入的字段</td></tr>
    178. 

  178.             </table>
    179. 

  179.             <div class="section-title">请求示例</div>
    180. 

  180.             <pre><code>{
    181. 

  181.   "id": 1,
    182. 

  182.   "version": "1.0.1",
    183. 

  183.   "updateContent": "1. 修复登录问题\n2. 优化性能\n3. 新增导出功能",
    184. 

  184.   "remark": "更新备注"
    185. 

  185. }</code></pre>
    186. 

  186.             <div class="section-title">响应示例</div>
    187. 

  187.             <pre><code>{
    188. 

  188.   "code": 200,
    189. 

  189.   "message": "更新成功",
    190. 

  190.   "success": true,
    191. 

  191.   "timestamp": 1724000000000,
    192. 

  192.   "data": { ... }
    193. 

  193. }</code></pre>
    194. 

  194.             <div class="section-title">错误响应</div>
    195. 

  195.             <pre><code>// ID为空
    196. 

  196. { "code": 400, "message": "ID不能为空", "success": false, "timestamp": 1724000000000, "data": null }
    197. 

  197. 

  198. // 记录不存在
    199. 

  199. { "code": 404, "message": "记录不存在", "success": false, "timestamp": 1724000000000, "data": null }</code></pre>
    200. 

  200.         </div>
    201. 

  201.     </div>
    202. 

  202. 

  203.     <!-- ==================== 删除 ==================== -->
    204. 

  204.     <div class="api-card">
    205. 

  205.         <div class="api-header" onclick="toggle(this)">
    206. 

  206.             <div>
    207. 

  207.                 <span class="api-title">删除发布日志（逻辑删除）</span>
    208. 

  208.             </div>
    209. 

  209.             <div style="display:flex;align-items:center;gap:10px;">
    210. 

  210.                 <span class="api-path">POST /service/manage/appReleaseLog/delete</span>
    211. 

  211.                 <span class="toggle-icon">▼</span>
    212. 

  212.             </div>
    213. 

  213.         </div>
    214. 

  214.         <div class="api-body">
    215. 

  215.             <div class="note"><b>注意：</b>使用 MyBatis-Plus 逻辑删除，rec_status 由 <code>A</code> 变为 <code>I</code>，数据不会物理删除。</div>
    216. 

  216.             <div class="section-title">请求体 (JSON)</div>
    217. 

  217.             <table>
    218. 

  218.                 <tr><th>字段</th><th>类型</th><th>必填</th><th>说明</th></tr>
    219. 

  219.                 <tr><td><code>id</code></td><td>Integer</td><td><span class="required">是</span></td><td>记录ID</td></tr>
    220. 

  220.             </table>
    221. 

  221.             <div class="section-title">请求示例</div>
    222. 

  222.             <pre><code>{
    223. 

  223.   "id": 1
    224. 

  224. }</code></pre>
    225. 

  225.             <div class="section-title">响应示例</div>
    226. 

  226.             <pre><code>{
    227. 

  227.   "code": 200,
    228. 

  228.   "message": "删除成功",
    229. 

  229.   "success": true,
    230. 

  230.   "timestamp": 1724000000000,
    231. 

  231.   "data": null
    232. 

  232. }</code></pre>
    233. 

  233.         </div>
    234. 

  234.     </div>
    235. 

  235. 

  236.     <!-- ==================== 数据字典 ==================== -->
    237. 

  237.     <div class="api-card">
    238. 

  238.         <div class="api-header" onclick="toggle(this)">
    239. 

  239.             <div>
    240. 

  240.                 <span class="api-title">数据字典 & 字段说明</span>
    241. 

  241.             </div>
    242. 

  242.             <div style="display:flex;align-items:center;gap:10px;">
    243. 

  243.                 <span class="toggle-icon">▼</span>
    244. 

  244.             </div>
    245. 

  245.         </div>
    246. 

  246.         <div class="api-body">
    247. 

  247.             <div class="section-title">表结构: t_app_release_log</div>
    248. 

  248.             <table>
    249. 

  249.                 <tr><th>字段</th><th>类型</th><th>说明</th></tr>
    250. 

  250.                 <tr><td><code>id</code></td><td>Integer (AUTO_INCREMENT)</td><td>主键ID</td></tr>
    251. 

  251.                 <tr><td><code>app_code</code></td><td>VARCHAR</td><td>应用标识（多系统区分，如 local_server、client）</td></tr>
    252. 

  252.                 <tr><td><code>public_target</code></td><td>VARCHAR</td><td>发布目标</td></tr>
    253. 

  253.                 <tr><td><code>version</code></td><td>VARCHAR</td><td>版本号</td></tr>
    254. 

  254.                 <tr><td><code>package_target</code></td><td>VARCHAR</td><td>打包目录</td></tr>
    255. 

  255.                 <tr><td><code>public_address</code></td><td>VARCHAR</td><td>发布地址</td></tr>
    256. 

  256.                 <tr><td><code>update_content</code></td><td>TEXT</td><td>发布内容</td></tr>
    257. 

  257.                 <tr><td><code>remark</code></td><td>VARCHAR</td><td>备注</td></tr>
    258. 

  258.                 <tr><td><code>env_tag</code></td><td>VARCHAR</td><td>环境标识：cn, eur, jp, ga</td></tr>
    259. 

  259.                 <tr><td><code>publish_ip</code></td><td>VARCHAR</td><td>发布操作IP（后端自动获取）</td></tr>
    260. 

  260.                 <tr><td><code>publish_user</code></td><td>BIGINT</td><td>发布操作人（后端自动获取，当前登录用户ID）</td></tr>
    261. 

  261.                 <tr><td><code>rec_status</code></td><td>CHAR(1)</td><td>记录状态：A=正常, I=已删除（逻辑删除）</td></tr>
    262. 

  262.                 <tr><td><code>create_time</code></td><td>DATETIME</td><td>创建时间（新增时自动填充）</td></tr>
    263. 

  263.                 <tr><td><code>update_time</code></td><td>DATETIME</td><td>更新时间（新增/更新时自动填充）</td></tr>
    264. 

  264.             </table>
    265. 

  265. 

  266.             <div class="section-title">统一响应结构 (ResultData)</div>
    267. 

  267.             <table>
    268. 

  268.                 <tr><th>字段</th><th>类型</th><th>说明</th></tr>
    269. 

  269.                 <tr><td><code>code</code></td><td>int</td><td>状态码：200=成功, 400=参数错误, 404=记录不存在, 500=系统错误</td></tr>
    270. 

  270.                 <tr><td><code>message</code></td><td>String</td><td>响应信息</td></tr>
    271. 

  271.                 <tr><td><code>success</code></td><td>Boolean</td><td>是否成功</td></tr>
    272. 

  272.                 <tr><td><code>data</code></td><td>Object</td><td>响应数据</td></tr>
    273. 

  273.                 <tr><td><code>timestamp</code></td><td>long</td><td>响应时间戳（毫秒）</td></tr>
    274. 

  274.             </table>
    275. 

  275.         </div>
    276. 

  276.     </div>
    277. 

  277. </div>
    278. 

  278. 

  279. <script>
    280. 

  280. function toggle(header) {
    281. 

  281.     const body = header.nextElementSibling;
    282. 

  282.     const icon = header.querySelector('.toggle-icon');
    283. 

  283.     body.classList.toggle('open');
    284. 

  284.     icon.classList.toggle('rotated');
    285. 

  285. }
    286. 

  286. </script>
    287. 

  287. </body>
    288. 

  288. </html>
    289.