接口文档

接口文档


听书书架

<h5>简要描述</h5> <ul> <li>听书书架</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://xx.com/api/listenShelf</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;">int</td> <td>页码</td> </tr> <tr> <td style="text-align: left;">pageSize</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>数量</td> </tr> <tr> <td style="text-align: left;">group_id</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>分组id 默认为0 获取分组中的小说传</td> </tr> <tr> <td style="text-align: left;">sort_field</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>排序方式 默认最后更新时间 last_episode_time 按最后阅读时间 read_episode_time</td> </tr> <tr> <td style="text-align: left;">sort_order</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>默认 倒序desc 正序asc</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{ "code": 200, "message": "ok", "data": { "data": [ { "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": false, "is_top": false, "number": 2, "create_time": 1628826384, "update_time": 1628826384, "created_at": "2021-08-13 11:46:24", "updated_at": "2021-08-13 11:58:10", "listen": null, "group_listen": [ { "id": 1, "cover": "/upload/images/20200517/20200517151645589599960452.jpg", "title": "回到民国当小编听书", "status_name": "", "sign_status_name": "", "sell_status_name": "", "first_type_name": "", "process_name": "" }, { "id": 3, "cover": "/upload/images/20201003/20201003003545282294558878.jpg", "title": "追先听书", "status_name": "", "sign_status_name": "", "sell_status_name": "", "first_type_name": "", "process_name": "" } ] }, { "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": false, "is_top": false, "number": 0, "create_time": 1628826614, "update_time": 1628826614, "created_at": "2021-08-13 11:50:14", "updated_at": "2021-08-13 11:50:14", "listen": null, "group_listen": [] }, { "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": false, "is_top": false, "number": 0, "create_time": 1628826618, "update_time": 1628826618, "created_at": "2021-08-13 11:50:18", "updated_at": "2021-08-13 11:50:18", "listen": null, "group_listen": [] }, { "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": false, "is_top": false, "number": 0, "create_time": 1628826623, "update_time": 1628826623, "created_at": "2021-08-13 11:50:23", "updated_at": "2021-08-13 11:50:23", "listen": null, "group_listen": [] }, { "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": false, "is_top": false, "number": 0, "create_time": 1628826640, "update_time": 1628826640, "created_at": "2021-08-13 11:50:40", "updated_at": "2021-08-13 11:50:40", "listen": null, "group_listen": [] }, { "id": 18, "user_id": 48724, "type": "listen", "listen_id": 2, "group_id": 0, "title": "", "last_episode_id": 0, "last_episode_title": "", "last_episode_time": 0, "read_episode_id": 0, "read_episode_title": "", "read_episode_time": 0, "is_update": false, "is_top": false, "number": 0, "create_time": 1628826105, "update_time": 1628826105, "created_at": "2021-08-13 11:41:45", "updated_at": "2021-08-13 11:58:10", "listen": { "id": 2, "title": "战国听书", "user_id": 48724, "author_id": 20944, "novel_id": 871, "author_nickname": "萧野", "cover": "/upload/images/20200516/20200516160429854767992122.jpg", "description": "战者,兵之利器也!\n在这个动荡的时代,不战,何来国?何来家?\n面对强权,面对外族入侵,热血男儿自当手握七尺长剑,奋起抵抗,血战沙场!\n书友催更群:1418868", "status_name": "", "sign_status_name": "", "sell_status_name": "", "first_type_name": "", "process_name": "" } } ], "total": 6, "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>当type为group时作为分组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>group为分组listen为听书</td> </tr> <tr> <td style="text-align: left;">listen_id</td> <td style="text-align: left;">int</td> <td>听书id</td> </tr> <tr> <td style="text-align: left;">group_id</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>type为group时作为分组名称</td> </tr> <tr> <td style="text-align: left;">last_episode_id</td> <td style="text-align: left;">int</td> <td>最新一集id</td> </tr> <tr> <td style="text-align: left;">last_episode_title</td> <td style="text-align: left;">int</td> <td>最新一集名称</td> </tr> <tr> <td style="text-align: left;">last_episode_time</td> <td style="text-align: left;">int</td> <td>最新一集时间</td> </tr> <tr> <td style="text-align: left;">read_episode_id</td> <td style="text-align: left;">int</td> <td>阅读记录剧集id</td> </tr> <tr> <td style="text-align: left;">read_episode_title</td> <td style="text-align: left;">int</td> <td>阅读记录标题</td> </tr> <tr> <td style="text-align: left;">read_episode_time</td> <td style="text-align: left;">int</td> <td>阅读记录时间</td> </tr> <tr> <td style="text-align: left;">is_update</td> <td style="text-align: left;">int</td> <td>是否有更新</td> </tr> <tr> <td style="text-align: left;">is_top</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> <tr> <td style="text-align: left;">listen</td> <td style="text-align: left;">int</td> <td>听书信息</td> </tr> <tr> <td style="text-align: left;">group_listen</td> <td style="text-align: left;">int</td> <td>分组下的听书列表信息</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul> <p>欢迎使用ShowDoc!</p>

页面列表

ITEM_HTML