index.html.vue 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. <template><div><h1 id="api-概述" tabindex="-1"><a class="header-anchor" href="#api-概述"><span>API 概述</span></a></h1>
  2. <p>Tappo 提供 REST API 用于外部集成。</p>
  3. <h2 id="基础信息" tabindex="-1"><a class="header-anchor" href="#基础信息"><span>基础信息</span></a></h2>
  4. <ul>
  5. <li>地址: <code v-pre>http://127.0.0.1:8956</code></li>
  6. <li>格式: JSON</li>
  7. </ul>
  8. <h2 id="主要接口" tabindex="-1"><a class="header-anchor" href="#主要接口"><span>主要接口</span></a></h2>
  9. <table>
  10. <thead>
  11. <tr>
  12. <th>接口</th>
  13. <th>说明</th>
  14. </tr>
  15. </thead>
  16. <tbody>
  17. <tr>
  18. <td><code v-pre>GET /health</code></td>
  19. <td>健康检查</td>
  20. </tr>
  21. <tr>
  22. <td><code v-pre>GET /api/workflows</code></td>
  23. <td>获取工作流列表</td>
  24. </tr>
  25. <tr>
  26. <td><code v-pre>POST /api/workflow/execute_once</code></td>
  27. <td>执行工作流</td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. <h2 id="响应格式" tabindex="-1"><a class="header-anchor" href="#响应格式"><span>响应格式</span></a></h2>
  32. <div class="language-json line-numbers-mode" data-highlighter="prismjs" data-ext="json"><pre v-pre><code class="language-json"><span class="line"><span class="token punctuation">{</span></span>
  33. <span class="line"> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span></span>
  34. <span class="line"> <span class="token property">"msg"</span><span class="token operator">:</span> <span class="token string">"成功"</span><span class="token punctuation">,</span></span>
  35. <span class="line"> <span class="token property">"data"</span><span class="token operator">:</span> <span class="token punctuation">{</span><span class="token punctuation">}</span></span>
  36. <span class="line"><span class="token punctuation">}</span></span>
  37. <span class="line"></span></code></pre>
  38. <div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></div></template>