Astroluma API参考手册完整后端接口文档与使用示例【免费下载链接】AstrolumaAstroluma is a feature-rich, user-friendly dashboard designed to help you manage multiple aspects of your daily tasks and services.项目地址: https://gitcode.com/gh_mirrors/as/AstrolumaAstroluma是一个功能丰富、用户友好的仪表板旨在帮助您管理日常任务和服务的多个方面。本API参考手册提供了完整的Astroluma后端接口文档帮助开发者和普通用户理解和使用Astroluma的API接口。无论您是想要集成Astroluma到其他系统还是需要自定义扩展功能这份API文档都将为您提供详细指导。 核心API概览Astroluma采用RESTful API架构所有API端点都需要通过JWT令牌进行身份验证除了登录接口。API主要分为以下几个功能模块 认证API登录认证POST /api/login- 用户登录获取访问令牌令牌验证通过verifyToken中间件保护所有受保护的端点 列表管理APIAstroluma的核心功能之一用于管理文件夹、链接、待办事项和代码片段端点方法功能描述/api/listing/save/folderPOST保存文件夹/api/listing/save/linkPOST保存链接/api/listing/save/todoPOST保存待办事项/api/listing/save/snippetPOST保存代码片段/api/listing/folder/listGET获取文件夹列表/api/listing/folder/:listingId/listGET获取特定文件夹内容/api/listing/delete/:listingIdGET删除列表项 应用程序集成APIAstroluma支持多种第三方应用集成相关API位于server/routes/app.js端点方法功能描述/api/app/run/:listingId/:appIdGET运行集成应用/api/app/installedGET获取已安装应用列表/api/app/fromzipPOST从ZIP文件安装应用/api/app/:appId/installGET安装远程应用/api/app/:appId/updateGET更新应用 用户账户管理API用户管理相关接口定义在server/routes/accounts.js端点方法功能描述/api/accounts/savePOST保存账户信息/api/accounts/listGET获取用户列表/api/accounts/info/:userIdGET获取用户信息/api/accounts/password/:userIdPOST修改密码/api/accounts/avatarPOST更新头像 网络设备管理API网络设备扫描和管理的API接口位于server/routes/networkdevice.js端点方法功能描述/api/networkdevices/save/devicePOST保存网络设备/api/networkdevices/devicesGET获取网络设备列表/api/networkdevices/wake/:deviceIdGET唤醒网络设备/api/networkdevices/delete/:deviceIdGET删除网络设备✅ 待办事项管理API待办事项管理功能API位于server/routes/todo.js端点方法功能描述/api/todo/itemPOST创建待办事项/api/todo/all/items/:completion/:filter/:pageGET获取所有待办事项/api/todo/completion/:todoIdGET标记待办事项完成/api/todo/:todoId/delete/:itemIdGET删除待办事项项 API使用示例1. 用户认证示例// 登录获取令牌 const loginResponse await fetch(/api/login, { method: POST, headers: { Content-Type: application/json }, body: JSON.stringify({ username: your_username, password: your_password }) }); const { token } await loginResponse.json(); // 使用令牌访问受保护API const response await fetch(/api/listing/folder/list, { method: GET, headers: { Authorization: Bearer ${token} } });2. 创建文件夹示例const createFolderResponse await fetch(/api/listing/save/folder, { method: POST, headers: { Content-Type: application/json, Authorization: Bearer ${token} }, body: JSON.stringify({ name: 工作文件夹, description: 日常工作相关链接, parentId: null, color: #3b82f6 }) });3. 安装应用示例// 通过ZIP文件安装应用 const formData new FormData(); formData.append(file, zipFile); const installResponse await fetch(/api/app/fromzip, { method: POST, headers: { Authorization: Bearer ${token} }, body: formData }); 数据模型结构Astroluma使用MongoDB作为数据库主要数据模型包括用户模型 (server/models/User.js)用户基本信息认证凭据个性化设置列表模型 (server/models/Listing.js)文件夹、链接、待办事项、代码片段层级结构支持排序和分类应用模型 (server/models/App.js)集成应用配置应用元数据集成状态 安全与认证JWT令牌认证所有受保护的API端点都需要在请求头中包含有效的JWT令牌Authorization: Bearer your_jwt_token权限控制用户只能访问自己的数据管理员可以管理所有用户账户应用集成需要特定权限 高级功能API流媒体预览APIAstroluma支持IP摄像头流媒体预览相关API端点/api/listing/stream/preview/:listingId- 生成流媒体预览图标包管理API自定义图标包管理接口/api/iconpack/save- 保存图标包配置/api/iconpack/list- 获取图标包列表页面管理API自定义页面创建和管理/api/page/save- 保存页面/api/page/list- 获取页面列表/api/page/:pageId- 获取特定页面 错误处理常见HTTP状态码200- 请求成功400- 请求参数错误401- 未授权访问403- 禁止访问404- 资源未找到500- 服务器内部错误错误响应格式{ error: 错误描述, code: 错误代码, timestamp: 2025-01-01T12:00:00Z } 性能优化建议批量操作尽可能使用批量API减少请求次数分页查询使用分页参数处理大量数据缓存策略合理使用客户端缓存连接复用保持HTTP连接复用️ 开发工具与资源客户端API服务Astroluma提供了完善的客户端API服务类位于client/src/utils/ApiService.js包含自动令牌管理错误处理请求重试机制文件上传支持中间件认证中间件位于server/middlewares/auth.js提供JWT令牌验证用户会话管理权限检查 API版本与兼容性Astroluma API保持向后兼容性所有API端点都遵循RESTful设计原则。建议开发者始终使用最新的API版本处理API响应中的版本信息实现优雅降级机制关注API更新日志 最佳实践请求优化使用适当的HTTP方法GET、POST、PUT、DELETE合理设置请求超时实现请求重试机制使用压缩传输安全性考虑定期更新访问令牌使用HTTPS协议验证输入数据限制API调用频率监控与日志记录API调用统计监控响应时间设置警报阈值分析使用模式 总结Astroluma提供了完整且易于使用的API接口涵盖了仪表板的所有核心功能。通过本参考手册您可以快速了解如何集成和使用Astroluma的各种功能。无论是简单的数据检索还是复杂的应用集成Astroluma的API都能满足您的需求。记住所有API调用都需要正确的身份验证并且建议在生产环境中使用HTTPS协议以确保数据传输的安全性。随着Astroluma的持续发展API功能将不断扩展和完善为用户提供更强大的集成能力。【免费下载链接】AstrolumaAstroluma is a feature-rich, user-friendly dashboard designed to help you manage multiple aspects of your daily tasks and services.项目地址: https://gitcode.com/gh_mirrors/as/Astroluma创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
Astroluma API参考手册：完整后端接口文档与使用示例
发布时间：2026/7/10 16:38:40
Astroluma API参考手册完整后端接口文档与使用示例【免费下载链接】AstrolumaAstroluma is a feature-rich, user-friendly dashboard designed to help you manage multiple aspects of your daily tasks and services.项目地址: https://gitcode.com/gh_mirrors/as/AstrolumaAstroluma是一个功能丰富、用户友好的仪表板旨在帮助您管理日常任务和服务的多个方面。本API参考手册提供了完整的Astroluma后端接口文档帮助开发者和普通用户理解和使用Astroluma的API接口。无论您是想要集成Astroluma到其他系统还是需要自定义扩展功能这份API文档都将为您提供详细指导。 核心API概览Astroluma采用RESTful API架构所有API端点都需要通过JWT令牌进行身份验证除了登录接口。API主要分为以下几个功能模块 认证API登录认证POST /api/login- 用户登录获取访问令牌令牌验证通过verifyToken中间件保护所有受保护的端点 列表管理APIAstroluma的核心功能之一用于管理文件夹、链接、待办事项和代码片段端点方法功能描述/api/listing/save/folderPOST保存文件夹/api/listing/save/linkPOST保存链接/api/listing/save/todoPOST保存待办事项/api/listing/save/snippetPOST保存代码片段/api/listing/folder/listGET获取文件夹列表/api/listing/folder/:listingId/listGET获取特定文件夹内容/api/listing/delete/:listingIdGET删除列表项 应用程序集成APIAstroluma支持多种第三方应用集成相关API位于server/routes/app.js端点方法功能描述/api/app/run/:listingId/:appIdGET运行集成应用/api/app/installedGET获取已安装应用列表/api/app/fromzipPOST从ZIP文件安装应用/api/app/:appId/installGET安装远程应用/api/app/:appId/updateGET更新应用 用户账户管理API用户管理相关接口定义在server/routes/accounts.js端点方法功能描述/api/accounts/savePOST保存账户信息/api/accounts/listGET获取用户列表/api/accounts/info/:userIdGET获取用户信息/api/accounts/password/:userIdPOST修改密码/api/accounts/avatarPOST更新头像 网络设备管理API网络设备扫描和管理的API接口位于server/routes/networkdevice.js端点方法功能描述/api/networkdevices/save/devicePOST保存网络设备/api/networkdevices/devicesGET获取网络设备列表/api/networkdevices/wake/:deviceIdGET唤醒网络设备/api/networkdevices/delete/:deviceIdGET删除网络设备✅ 待办事项管理API待办事项管理功能API位于server/routes/todo.js端点方法功能描述/api/todo/itemPOST创建待办事项/api/todo/all/items/:completion/:filter/:pageGET获取所有待办事项/api/todo/completion/:todoIdGET标记待办事项完成/api/todo/:todoId/delete/:itemIdGET删除待办事项项 API使用示例1. 用户认证示例// 登录获取令牌 const loginResponse await fetch(/api/login, { method: POST, headers: { Content-Type: application/json }, body: JSON.stringify({ username: your_username, password: your_password }) }); const { token } await loginResponse.json(); // 使用令牌访问受保护API const response await fetch(/api/listing/folder/list, { method: GET, headers: { Authorization: Bearer ${token} } });2. 创建文件夹示例const createFolderResponse await fetch(/api/listing/save/folder, { method: POST, headers: { Content-Type: application/json, Authorization: Bearer ${token} }, body: JSON.stringify({ name: 工作文件夹, description: 日常工作相关链接, parentId: null, color: #3b82f6 }) });3. 安装应用示例// 通过ZIP文件安装应用 const formData new FormData(); formData.append(file, zipFile); const installResponse await fetch(/api/app/fromzip, { method: POST, headers: { Authorization: Bearer ${token} }, body: formData }); 数据模型结构Astroluma使用MongoDB作为数据库主要数据模型包括用户模型 (server/models/User.js)用户基本信息认证凭据个性化设置列表模型 (server/models/Listing.js)文件夹、链接、待办事项、代码片段层级结构支持排序和分类应用模型 (server/models/App.js)集成应用配置应用元数据集成状态 安全与认证JWT令牌认证所有受保护的API端点都需要在请求头中包含有效的JWT令牌Authorization: Bearer your_jwt_token权限控制用户只能访问自己的数据管理员可以管理所有用户账户应用集成需要特定权限 高级功能API流媒体预览APIAstroluma支持IP摄像头流媒体预览相关API端点/api/listing/stream/preview/:listingId- 生成流媒体预览图标包管理API自定义图标包管理接口/api/iconpack/save- 保存图标包配置/api/iconpack/list- 获取图标包列表页面管理API自定义页面创建和管理/api/page/save- 保存页面/api/page/list- 获取页面列表/api/page/:pageId- 获取特定页面 错误处理常见HTTP状态码200- 请求成功400- 请求参数错误401- 未授权访问403- 禁止访问404- 资源未找到500- 服务器内部错误错误响应格式{ error: 错误描述, code: 错误代码, timestamp: 2025-01-01T12:00:00Z } 性能优化建议批量操作尽可能使用批量API减少请求次数分页查询使用分页参数处理大量数据缓存策略合理使用客户端缓存连接复用保持HTTP连接复用️ 开发工具与资源客户端API服务Astroluma提供了完善的客户端API服务类位于client/src/utils/ApiService.js包含自动令牌管理错误处理请求重试机制文件上传支持中间件认证中间件位于server/middlewares/auth.js提供JWT令牌验证用户会话管理权限检查 API版本与兼容性Astroluma API保持向后兼容性所有API端点都遵循RESTful设计原则。建议开发者始终使用最新的API版本处理API响应中的版本信息实现优雅降级机制关注API更新日志 最佳实践请求优化使用适当的HTTP方法GET、POST、PUT、DELETE合理设置请求超时实现请求重试机制使用压缩传输安全性考虑定期更新访问令牌使用HTTPS协议验证输入数据限制API调用频率监控与日志记录API调用统计监控响应时间设置警报阈值分析使用模式 总结Astroluma提供了完整且易于使用的API接口涵盖了仪表板的所有核心功能。通过本参考手册您可以快速了解如何集成和使用Astroluma的各种功能。无论是简单的数据检索还是复杂的应用集成Astroluma的API都能满足您的需求。记住所有API调用都需要正确的身份验证并且建议在生产环境中使用HTTPS协议以确保数据传输的安全性。随着Astroluma的持续发展API功能将不断扩展和完善为用户提供更强大的集成能力。【免费下载链接】AstrolumaAstroluma is a feature-rich, user-friendly dashboard designed to help you manage multiple aspects of your daily tasks and services.项目地址: https://gitcode.com/gh_mirrors/as/Astroluma创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
