Deployed 63dc914 to v2 with MkDocs 1.6.1 and mike 1.1.2

Author: Andyguo5891

v2/dev_manual/api_manual/index.html

@@ -99,7 +99,7 @@
     <div data-md-component="skip">
 
 
-        <a href="#api" class="md-skip">
+        <a href="#1" class="md-skip">
           跳转至
         </a>
 
@@ -2937,55 +2937,37 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#api" class="md-nav__link">
+  <a href="#1" class="md-nav__link">
     <span class="md-ellipsis">
-      API 接口配置与使用指南
+      1 接口配置说明
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="API 接口配置与使用指南">
+    <nav class="md-nav" aria-label="1 接口配置说明">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#swagger" class="md-nav__link">
+  <a href="#11-token" class="md-nav__link">
     <span class="md-ellipsis">
-      以下内容已通过 Swagger 进行验证
+      1.1 自定义 Token 格式
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#token" class="md-nav__link">
+  <a href="#12-header" class="md-nav__link">
     <span class="md-ellipsis">
-      自定义 Token 格式
+      1.2 请求 Header 设计
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#header" class="md-nav__link">
+  <a href="#13" class="md-nav__link">
     <span class="md-ellipsis">
-      请求 Header 设计
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#_1" class="md-nav__link">
-    <span class="md-ellipsis">
-      示例请求头：
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#go" class="md-nav__link">
-    <span class="md-ellipsis">
-      示例实现代码(go)
+      1.3 示例实现代码
     </span>
   </a>
 
@@ -2997,27 +2979,18 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#_2" class="md-nav__link">
+  <a href="#2" class="md-nav__link">
     <span class="md-ellipsis">
-      注意事项
+      2 注意事项
     </span>
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#_3" class="md-nav__link">
+  <a href="#3" class="md-nav__link">
     <span class="md-ellipsis">
-      常见问题
-    </span>
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#_4" class="md-nav__link">
-    <span class="md-ellipsis">
-      结语
+      3 常见问题
     </span>
   </a>
 
@@ -3100,55 +3073,37 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#api" class="md-nav__link">
+  <a href="#1" class="md-nav__link">
     <span class="md-ellipsis">
-      API 接口配置与使用指南
+      1 接口配置说明
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="API 接口配置与使用指南">
+    <nav class="md-nav" aria-label="1 接口配置说明">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#swagger" class="md-nav__link">
-    <span class="md-ellipsis">
-      以下内容已通过 Swagger 进行验证
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#token" class="md-nav__link">
-    <span class="md-ellipsis">
-      自定义 Token 格式
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#header" class="md-nav__link">
+  <a href="#11-token" class="md-nav__link">
     <span class="md-ellipsis">
-      请求 Header 设计
+      1.1 自定义 Token 格式
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#_1" class="md-nav__link">
+  <a href="#12-header" class="md-nav__link">
     <span class="md-ellipsis">
-      示例请求头：
+      1.2 请求 Header 设计
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#go" class="md-nav__link">
+  <a href="#13" class="md-nav__link">
     <span class="md-ellipsis">
-      示例实现代码(go)
+      1.3 示例实现代码
     </span>
   </a>
 
@@ -3160,27 +3115,18 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#_2" class="md-nav__link">
+  <a href="#2" class="md-nav__link">
     <span class="md-ellipsis">
-      注意事项
+      2 注意事项
     </span>
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#_3" class="md-nav__link">
+  <a href="#3" class="md-nav__link">
     <span class="md-ellipsis">
-      常见问题
-    </span>
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#_4" class="md-nav__link">
-    <span class="md-ellipsis">
-      结语
+      3 常见问题
     </span>
   </a>
 
@@ -3204,12 +3150,15 @@
 
   <h1>API 接口</h1>
 
-<h2 id="api">API 接口配置与使用指南<a class="headerlink" href="#api" title="Permanent link">⚓︎</a></h2>
+<div class="admonition note"></div>
 <p>本文档详细介绍了如何在三方服务中使用自定义 Token 的验证来访问面板接口。</p>
-<h3 id="swagger">以下内容已通过 Swagger 进行验证<a class="headerlink" href="#swagger" title="Permanent link">⚓︎</a></h3>
-<p>面板 swagger 访问地址：<code>{host}:{port}/1panel/swagger/index.html</code></p>
-<h3 id="token">自定义 Token 格式<a class="headerlink" href="#token" title="Permanent link">⚓︎</a></h3>
-<p>我们设计了以下自定义 Token 格式，用于接口请求的身份验证：</p>
+<h2 id="1">1 接口配置说明<a class="headerlink" href="#1" title="Permanent link">⚓︎</a></h2>
+<div class="admonition note">
+<p>登录后，可通过访问 swagger 访问地址：<code>{host}:{port}/1panel/swagger/index.html</code> 查看所有 API。</p>
+</div>
+<h3 id="11-token">1.1 自定义 Token 格式<a class="headerlink" href="#11-token" title="Permanent link">⚓︎</a></h3>
+<div class="admonition note">
+<p>1Panel 设计了以下自定义 Token 格式，用于接口请求的身份验证：</p>
 <div class="highlight"><pre><span></span><code>Token = md5(&#39;1panel&#39; + API-Key + UnixTimestamp)
 </code></pre></div>
 <p>组成部分：</p>
@@ -3218,7 +3167,9 @@ <h3 id="token">自定义 Token 格式<a class="headerlink" href="#token" title="
 <li>API-Key: 面板 API 接口密钥</li>
 <li>UnixTimestamp: 当前的时间戳（秒级）</li>
 </ul>
-<h3 id="header">请求 Header 设计<a class="headerlink" href="#header" title="Permanent link">⚓︎</a></h3>
+</div>
+<h3 id="12-header">1.2  请求 Header 设计<a class="headerlink" href="#12-header" title="Permanent link">⚓︎</a></h3>
+<div class="admonition note">
 <p>每次请求必须携带以下两个 Header：</p>
 <table>
 <thead>
@@ -3238,12 +3189,15 @@ <h3 id="header">请求 Header 设计<a class="headerlink" href="#header" title="
 </tr>
 </tbody>
 </table>
-<h3 id="_1">示例请求头：<a class="headerlink" href="#_1" title="Permanent link">⚓︎</a></h3>
+<p>示例请求头：</p>
 <div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span><span class="s2">&quot;http://localhost:4004/api/v1/dashboard/current&quot;</span><span class="w"> </span><span class="se">\</span>
 -H<span class="w"> </span><span class="s2">&quot;1Panel-Token: &lt;1panel_token&gt;&quot;</span><span class="w"> </span><span class="se">\</span>
 -H<span class="w"> </span><span class="s2">&quot;1Panel-Timestamp: &lt;current_unix_timestamp&gt;&quot;</span>
 </code></pre></div>
-<h3 id="go">示例实现代码(go)<a class="headerlink" href="#go" title="Permanent link">⚓︎</a></h3>
+</div>
+<h3 id="13">1.3 示例实现代码<a class="headerlink" href="#13" title="Permanent link">⚓︎</a></h3>
+<div class="admonition note">
+<p>以 go 语言为例，展示对应的实现代码：</p>
 <div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="nx">validateToken</span><span class="p">(</span><span class="nx">c</span><span class="w"> </span><span class="o">*</span><span class="nx">gin</span><span class="p">.</span><span class="nx">Context</span><span class="p">)</span><span class="w"> </span><span class="kt">error</span><span class="w"> </span><span class="p">{</span>
 <span class="w">    </span><span class="nx">panelToken</span><span class="w"> </span><span class="o">:=</span><span class="w"> </span><span class="nx">c</span><span class="p">.</span><span class="nx">GetHeader</span><span class="p">(</span><span class="s">&quot;1Panel-Token&quot;</span><span class="p">)</span>
 <span class="w">    </span><span class="nx">panelTimestamp</span><span class="w"> </span><span class="o">:=</span><span class="w"> </span><span class="nx">c</span><span class="p">.</span><span class="nx">GetHeader</span><span class="p">(</span><span class="s">&quot;1Panel-Timestamp&quot;</span><span class="p">)</span>
@@ -3262,36 +3216,25 @@ <h3 id="go">示例实现代码(go)<a class="headerlink" href="#go" title="Perman
 <span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="nx">hex</span><span class="p">.</span><span class="nx">EncodeToString</span><span class="p">(</span><span class="nx">h</span><span class="p">.</span><span class="nx">Sum</span><span class="p">(</span><span class="kc">nil</span><span class="p">))</span>
 <span class="p">}</span>
 </code></pre></div>
-<h2 id="_2">注意事项<a class="headerlink" href="#_2" title="Permanent link">⚓︎</a></h2>
-<ol>
-<li>
-<p>时间戳的有效性:
-需要确保服务器与客户端时间同步，否则会导致验证失败。建议使用 NTP 同步时间。</p>
-</li>
-<li>
-<p>白名单使用:
-将可信任的 IP 或 IP 段加入白名单，避免频繁 Token 验证的开销；如需放行所有 IP ，可以配置 <code>0.0.0.0</code>。</p>
-</li>
-</ol>
-<h2 id="_3">常见问题<a class="headerlink" href="#_3" title="Permanent link">⚓︎</a></h2>
-<ol>
-<li>
-<p>Q: 如果 1Panel-Token或1Panel-Timestamp 错误怎么办？
-   A: 返回 401 Unauthorized，提示 "API 接口密钥错误"。</p>
-</li>
-<li>
-<p>Q: 如何生成 1Panel-Token？
-   A: 参考以下伪代码：</p>
-</li>
-</ol>
+</div>
+<h2 id="2">2 注意事项<a class="headerlink" href="#2" title="Permanent link">⚓︎</a></h2>
+<div class="admonition note">
+<ul>
+<li>时间戳的有效性:需要确保服务器与客户端时间同步，否则会导致验证失败。建议使用 NTP 同步时间。</li>
+<li>白名单使用:将可信任的 IP 或 IP 段加入白名单，避免频繁 Token 验证的开销；如需放行所有 IP ，可以配置 <code>0.0.0.0</code>。</li>
+</ul>
+</div>
+<h2 id="3">3 常见问题<a class="headerlink" href="#3" title="Permanent link">⚓︎</a></h2>
+<div class="admonition note">
+<p>（1）如果 1Panel-Token或1Panel-Timestamp 错误怎么办？
+后台将返回 401 Unauthorized，并提示 "API 接口密钥错误"。</p>
+<p>（2）如何生成 1Panel-Token？</p>
+<p>请参考以下伪代码：</p>
 <div class="highlight"><pre><span></span><code><span class="kd">const</span><span class="w"> </span><span class="nx">token</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">md5</span><span class="p">(</span><span class="s1">&#39;1panel&#39;</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="nx">clientToken</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="nx">unixTimestamp</span><span class="p">);</span>
 </code></pre></div>
-<ol>
-<li>Q: 为什么需要两个 Header？
-   A: 提高验证的复杂度，同时增强安全性。</li>
-</ol>
-<h2 id="_4">结语<a class="headerlink" href="#_4" title="Permanent link">⚓︎</a></h2>
-<p>通过上述方式可以实现一个安全、高效的 Token 验证系统。如果有任何问题，请参考具体代码实现或联系我们获取支持。</p>
+<p>（3）为什么需要两个 Header？
+提高验证的复杂度，同时增强安全性。</p>
+</div>