二、接口说明

1. 接口概览

本文档描述了对号 Jo! 应用的后端 API 接口，这些接口用于主应用和子应用与后端服务器的通信。API 接口采用 RESTful 风格设计，使用 JSON 格式进行数据交换。

本文档提供了对号 Jo! 应用后端 API 的完整参考，包括接口分类、详细说明、参数格式和返回值示例。通过这些 API，前端应用可以实现与后端服务器的交互，完成文件管理、媒体播放、资源下载等核心功能。

如果您在使用这些 API 时遇到问题，请参考错误处理部分的说明，或者联系开发团队获取帮助。

1.1 基础 URL

开发环境：http://localhost:5198/api

生产环境：根据部署环境配置

1.2 响应格式

所有 API 接口的响应格式统一为：

{
  "code": 200,        // 状态码，200 表示成功，其他表示失败
  "message": "成功",   // 响应消息
  "data": {}          // 响应数据
}

1.3 错误处理

当 API 请求失败时，响应会包含错误状态码和错误消息：

{
  "code": 400,        // 错误状态码
  "message": "请求参数错误", // 错误消息
  "data": null        // 错误数据
}

常见的错误状态码：

400：请求参数错误

401：未授权，请重新登录

403：拒绝访问

404：请求的资源不存在

500：服务器内部错误

2. 接口分类

2.1 系统相关 API

用于获取系统状态和控制服务状态的接口。

2.2 网盘文件 API

用于文件的上传、下载、删除、搜索等操作的接口。

2.3 媒体相关 API

用于获取视频和音乐列表的接口。

2.4 资源相关 API

用于获取资源列表和下载任务的接口。

2.5 用户相关 API

用于获取用户信息和退出登录的接口。

2.6 分享管理 API

用于创建、验证、列出和取消分享的接口。

1. 接口概览#

1.1 基础 URL#

1.2 响应格式#

1.3 错误处理#

2. 接口分类#

2.1 系统相关 API#

2.2 网盘文件 API#

2.3 媒体相关 API#

2.4 资源相关 API#

2.5 用户相关 API#

2.6 分享管理 API#