接口文档

接口文档


书架分组列表

<h5>简要描述</h5> <ul> <li>分组列表</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://xx.com/api/listenShelfGroupList</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;">page</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>用户名</td> </tr> <tr> <td style="text-align: left;">pageSize</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>密码</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{ "code": 200, "message": "ok", "data": { "data": [ { "id": 17, "user_id": 48724, "type": "group", "listen_id": 0, "group_id": 0, "title": "分组6", "last_episode_id": 0, "last_episode_title": "", "last_episode_time": 0, "read_episode_id": 0, "read_episode_title": "", "read_episode_time": 0, "is_update": 0, "is_top": 0, "number": 0, "create_time": 1628826640, "update_time": 1628826640, "created_at": "2021-08-13 11:50:40", "updated_at": "2021-08-13 11:50:40" }, { "id": 15, "user_id": 48724, "type": "group", "listen_id": 0, "group_id": 0, "title": "分组4", "last_episode_id": 0, "last_episode_title": "", "last_episode_time": 0, "read_episode_id": 0, "read_episode_title": "", "read_episode_time": 0, "is_update": 0, "is_top": 0, "number": 0, "create_time": 1628826623, "update_time": 1628826623, "created_at": "2021-08-13 11:50:23", "updated_at": "2021-08-13 11:50:23" }, { "id": 14, "user_id": 48724, "type": "group", "listen_id": 0, "group_id": 0, "title": "分组3", "last_episode_id": 0, "last_episode_title": "", "last_episode_time": 0, "read_episode_id": 0, "read_episode_title": "", "read_episode_time": 0, "is_update": 0, "is_top": 0, "number": 0, "create_time": 1628826618, "update_time": 1628826618, "created_at": "2021-08-13 11:50:18", "updated_at": "2021-08-13 11:50:18" }, { "id": 13, "user_id": 48724, "type": "group", "listen_id": 0, "group_id": 0, "title": "分组2", "last_episode_id": 0, "last_episode_title": "", "last_episode_time": 0, "read_episode_id": 0, "read_episode_title": "", "read_episode_time": 0, "is_update": 0, "is_top": 0, "number": 0, "create_time": 1628826614, "update_time": 1628826614, "created_at": "2021-08-13 11:50:14", "updated_at": "2021-08-13 11:50:14" }, { "id": 12, "user_id": 48724, "type": "group", "listen_id": 0, "group_id": 0, "title": "分组1", "last_episode_id": 0, "last_episode_title": "", "last_episode_time": 0, "read_episode_id": 0, "read_episode_title": "", "read_episode_time": 0, "is_update": 0, "is_top": 0, "number": 2, "create_time": 1628826384, "update_time": 1628826384, "created_at": "2021-08-13 11:46:24", "updated_at": "2021-08-13 11:58:10" } ], "total": 5, "current_page": 1, "per_page": 10, "last_page": 1 } }</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;">id</td> <td style="text-align: left;">int</td> <td>分组id</td> </tr> <tr> <td style="text-align: left;">user_id</td> <td style="text-align: left;">int</td> <td>用户id</td> </tr> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">int</td> <td>类型</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">int</td> <td>分组名称</td> </tr> <tr> <td style="text-align: left;">number</td> <td style="text-align: left;">int</td> <td>分组下的听书数量</td> </tr> <tr> <td style="text-align: left;">create_time</td> <td style="text-align: left;">int</td> <td>创建时间</td> </tr> <tr> <td style="text-align: left;">update_time</td> <td style="text-align: left;">int</td> <td>更新时间</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul> <p>欢迎使用ShowDoc!</p>

页面列表

ITEM_HTML