笆林中控APP


获取帮助文档列表

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>获取帮助文档列表</li> </ul> <h5>请求URL</h5> <ul> <li><code>/api/v1/help/list</code></li> </ul> <h5>请求方式</h5> <ul> <li>GET </li> </ul> <h5>参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">pos</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>展示位置,为空表示查询所有</td> </tr> </tbody> </table> <h5>成功返回示例</h5> <pre><code> { &amp;quot;state&amp;quot;: &amp;quot;1&amp;quot;, &amp;quot;msg&amp;quot;: &amp;quot;获取成功&amp;quot;, &amp;quot;data&amp;quot;: [{ &amp;quot;id&amp;quot;: 76, &amp;quot;help_title&amp;quot;: &amp;quot;操作手册1&amp;quot;, &amp;quot;help_content&amp;quot;: &amp;quot;111111111111111111111&amp;quot;, &amp;quot;help_pos&amp;quot;: &amp;quot;默认&amp;quot;, &amp;quot;help_status&amp;quot;: 1, &amp;quot;help_order&amp;quot;: 1, &amp;quot;add_time&amp;quot;: &amp;quot;2023-10-10 00:00:00&amp;quot; }, { &amp;quot;id&amp;quot;: 76, &amp;quot;help_title&amp;quot;: &amp;quot;操作手册1&amp;quot;, &amp;quot;help_content&amp;quot;: &amp;quot;111111111111111111111&amp;quot;, &amp;quot;help_pos&amp;quot;: &amp;quot;默认&amp;quot;, &amp;quot;help_status&amp;quot;: 1, &amp;quot;help_order&amp;quot;: 1, &amp;quot;add_time&amp;quot;: &amp;quot;2023-10-10 00:00:00&amp;quot; }, { &amp;quot;id&amp;quot;: 76, &amp;quot;help_title&amp;quot;: &amp;quot;操作手册1&amp;quot;, &amp;quot;help_content&amp;quot;: &amp;quot;111111111111111111111&amp;quot;, &amp;quot;help_pos&amp;quot;: &amp;quot;远程服务&amp;quot;, &amp;quot;help_status&amp;quot;: 1, &amp;quot;help_order&amp;quot;: 1, &amp;quot;add_time&amp;quot;: &amp;quot;2023-10-10 00:00:00&amp;quot; } ] }</code></pre> <h5>失败返回示例</h5> <pre><code> { &amp;quot;state&amp;quot;: &amp;quot;-999&amp;quot;, &amp;quot;msg&amp;quot;: &amp;quot;拒绝访问:你没有权限&amp;quot;, &amp;quot;data&amp;quot;: &amp;quot;&amp;quot; }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">state</td> <td style="text-align: left;">string</td> <td>状态 1为成功,其他为失败</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">string</td> <td>接口返回信息</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">string</td> <td>数据域</td> </tr> </tbody> </table> <table> <thead> <tr> <th style="text-align: left;">data中的参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">int</td> <td>id</td> </tr> <tr> <td style="text-align: left;">help_title</td> <td style="text-align: left;">string</td> <td>标题</td> </tr> <tr> <td style="text-align: left;">help_content</td> <td style="text-align: left;">string</td> <td>内容</td> </tr> <tr> <td style="text-align: left;">help_pos</td> <td style="text-align: left;">string</td> <td>展示位置</td> </tr> <tr> <td style="text-align: left;">help_status</td> <td style="text-align: left;">int</td> <td>状态 0无效 1有效</td> </tr> <tr> <td style="text-align: left;">help_order</td> <td style="text-align: left;">int</td> <td>排序</td> </tr> <tr> <td style="text-align: left;">add_time</td> <td style="text-align: left;">datetime</td> <td>时间</td> </tr> </tbody> </table> <h5>错误代码</h5> <table> <thead> <tr> <th style="text-align: left;">代码名称</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">1</td> <td style="text-align: left;">string</td> <td>成功</td> </tr> <tr> <td style="text-align: left;">-1</td> <td style="text-align: left;">string</td> <td>参数有误</td> </tr> <tr> <td style="text-align: left;">-99</td> <td style="text-align: left;">string</td> <td>异常</td> </tr> <tr> <td style="text-align: left;">-999</td> <td style="text-align: left;">string</td> <td>拒绝访问:你没有权限</td> </tr> </tbody> </table>

页面列表

ITEM_HTML