用户认证相关

POST /api/v1/login 🌐 公开接口

用户登录

用户登录接口，支持用户名密码、手机验证码、第三方登录等多种方式

📝 请求参数

参数名类型必填说明
username string 是 用户名/手机号/邮箱
password string 是 用户密码
captcha string 否 图形验证码
type int 否 登录类型：1-用户名密码，2-手机验证码，3-第三方

📤 返回示例

{ "code": 0, "msg": "登录成功", "data": { "token": "jwt_token", "user_info": { "id": 1, "username": "test" }, "expires_in": 3600 } }

❌ 错误代码

Code 1: 用户名或密码错误
Code 2: 验证码错误
POST /api/v1/register 🌐 公开接口

用户注册

用户注册接口，支持用户名密码注册，可选绑定手机号和邮箱

📝 请求参数

参数名类型必填说明
username string 是 用户名（3-20位字符）
password string 是 密码（6-20位字符）
mobile string 否 手机号码
email string 否 邮箱地址
invite_code string 否 邀请码

📤 返回示例

{ "code": 0, "msg": "注册成功", "data": { "user_id": 123, "token": "jwt_token" } }

❌ 错误代码

Code 1: 用户名已存在
Code 2: 手机号已被注册
POST /api/v1/logout 🔒 需要认证

用户退出

用户退出登录，清除服务端会话状态

📝 请求参数

无需传递参数

📤 返回示例

{ "code": 0, "msg": "退出成功" }

❌ 错误代码

Code 99: 用户未登录
GET /api/v1/captcha 🌐 公开接口

获取验证码

获取图形验证码，用于登录、注册等操作的安全验证

📝 请求参数

无需传递参数

📤 返回示例

"返回验证码图片流（image\/png格式）"
GET /api/v1/gettoken 🌐 公开接口

获取访客Token

获取访客访问令牌，用于未登录用户的基础API访问

📝 请求参数

无需传递参数

📤 返回示例

{ "code": 0, "data": { "token": "guest_token", "expires_in": 3600 } }
POST /api/v1/smssend 🌐 公开接口

发送短信验证码

发送短信验证码，用于手机注册、找回密码等功能

📝 请求参数

参数名类型必填说明
mobile string 是 手机号码
type string 是 短信类型：register-注册，reset-重置密码

📤 返回示例

{ "code": 0, "msg": "短信发送成功" }

❌ 错误代码

Code 1: 手机号格式错误
Code 2: 发送频率过快

书籍管理相关

GET /api/v1/bookdetail 🌐 公开接口

书籍详情

获取指定书籍的详细信息，包括基本信息、章节列表、用户交互状态等

📝 请求参数

参数名类型必填说明
id int 是 书籍ID

📤 返回示例

{ "code": 0, "data": { "id": 1, "title": "书名", "author": "作者", "cover": "封面URL", "words": "字数", "chapters": "章节数", "fav": "是否收藏", "chapter": "章节列表" } }

❌ 错误代码

Code 1: 书籍不存在
Code 2: 书籍已下架
GET /api/v1/booklist 🌐 公开接口

书籍列表

获取书籍列表，支持分类筛选、关键词搜索、分页等功能

📝 请求参数

参数名类型必填说明
page int 否 页码，默认1
keywords string 否 搜索关键词
genre int 否 大分类ID
isfinish int 否 完结状态：0-连载，1-完结

📤 返回示例

{ "code": 0, "data": { "list": "书籍列表", "total": "总数", "page": "当前页" } }

❌ 错误代码

Code 1: 分类不存在
GET /api/v1/getdown 🔒 需要认证

获取下载信息

获取书籍下载链接和相关信息，需要用户登录

📝 请求参数

参数名类型必填说明
id int 是 书籍ID

📤 返回示例

{ "code": 0, "data": { "download_url": "下载链接", "file_size": "文件大小" } }

❌ 错误代码

Code 99: 需要登录
Code 1: 书籍不存在

分类管理相关

GET /api/v1/bigcate 🌐 公开接口

获取大分类

获取所有大分类列表，用于书籍分类展示

📝 请求参数

无需传递参数

📤 返回示例

{ "code": 0, "data": [ { "id": 1, "name": "玄幻", "ordernum": 1 } ] }
GET /api/v1/smallcate 🌐 公开接口

获取小分类

根据大分类ID获取对应的小分类列表

📝 请求参数

参数名类型必填说明
pid int 是 父分类ID

📤 返回示例

{ "code": 0, "data": [ { "id": 11, "name": "修真", "pid": 1 } ] }

❌ 错误代码

Code 1: 父分类不存在

搜索功能相关

GET /api/v1/search 🌐 公开接口

书籍搜索

书籍搜索功能，支持按书名、作者搜索，可按分类筛选和排序

📝 请求参数

参数名类型必填说明
keywords string 是 搜索关键词
page int 否 页码，默认1
category_id int 否 分类ID筛选

📤 返回示例

{ "code": 0, "data": { "list": "搜索结果", "total": "总数", "page": "页码" } }
GET /api/v1/keywords 🌐 公开接口

热门搜索关键词

获取热门搜索关键词列表，用于搜索推荐

📝 请求参数

参数名类型必填说明
limit int 否 返回数量，默认10

📤 返回示例

{ "code": 0, "data": [ { "keyword": "修真", "count": 1000 } ] }
GET /api/v1/searchlog 🔒 需要认证

搜索历史记录

获取用户的搜索历史记录

📝 请求参数

参数名类型必填说明
page int 否 页码

📤 返回示例

{ "code": 0, "data": [ { "keyword": "修真", "create_time": "搜索时间" } ] }

❌ 错误代码

Code 99: 需要登录
POST /api/v1/delsearchlog 🔒 需要认证

删除搜索记录

删除指定的搜索历史记录

📝 请求参数

参数名类型必填说明
keyword string 是 要删除的关键词

📤 返回示例

{ "code": 0, "msg": "删除成功" }

❌ 错误代码

Code 99: 需要登录

用户功能相关

POST /api/v1/favorites 🔒 需要认证

收藏/取消收藏

添加或取消书籍收藏，如果已收藏则取消，未收藏则添加

📝 请求参数

参数名类型必填说明
bookid int 是 书籍ID

📤 返回示例

{ "code": 0, "data": { "fid": "收藏ID，0表示取消收藏" } }

❌ 错误代码

Code 99: 需要登录
Code 1: 书籍不存在
POST /api/v1/follow 🔒 需要认证

关注/取消关注

关注或取消关注作者，如果已关注则取消，未关注则添加

📝 请求参数

参数名类型必填说明
from_id int 是 关注对象ID（作者ID）
type int 否 关注类型：1-作者，2-用户，默认1

📤 返回示例

{ "code": 0, "data": { "fid": "关注ID，0表示取消关注" } }

❌ 错误代码

Code 99: 需要登录
Code 1: 不能关注自己
POST /api/v1/signin 🔒 需要认证

用户签到

用户每日签到，获得金币奖励，连续签到有额外奖励

📝 请求参数

无需传递参数

📤 返回示例

{ "code": 0, "data": { "reward": "奖励金币", "continuous_days": "连续天数" } }

❌ 错误代码

Code 99: 需要登录
Code 1: 今日已签到