Websoft9 API详解：自动化部署和管理应用的完整指南

Websoft9 API详解：自动化部署和管理应用的完整指南

【免费下载链接】websoft9Applications self-hosting and DevOps platform for running open source, web-based linux Panel of lite PaaS项目地址: https://gitcode.com/gh_mirrors/we/websoft9

Websoft9是一个功能强大的开源自托管应用平台，它提供了全面的API接口，让开发者能够轻松实现应用的自动化部署和管理。通过Websoft9 API，您可以快速构建自定义的应用管理流程，提高工作效率，实现无缝的DevOps集成。

Websoft9 API架构概览

Websoft9 API采用现代化的RESTful设计风格，提供了清晰的接口结构和完善的功能覆盖。整个API系统基于FastAPI构建，确保了高性能和良好的开发体验。

Websoft9 API主要包含以下几个核心模块：

• 应用管理API：负责应用的安装、启动、停止、重启、卸载等全生命周期管理
• 备份管理API：提供应用数据的备份和恢复功能
• 代理管理API：处理域名代理和SSL证书相关操作
• 设置管理API：管理系统配置和参数

快速开始：Websoft9 API基础

要开始使用Websoft9 API，首先需要获取API访问权限。默认情况下，Websoft9 API服务运行在本地服务器的特定端口上，您可以通过HTTP请求直接访问。

API调用基本格式

Websoft9 API的基本URL格式如下：

http://your-websoft9-server/api/v1/

所有API端点都遵循RESTful设计原则，使用适当的HTTP方法表示不同的操作：

• GET：获取资源
• POST：创建资源
• PUT：更新资源
• DELETE：删除资源

认证方式

Websoft9 API采用JWT（JSON Web Token）认证机制，确保API调用的安全性。您需要先通过登录接口获取令牌，然后在后续请求的HTTP头部中包含该令牌：

Authorization: Bearer your-jwt-token

核心API详解

应用管理API

应用管理API是Websoft9的核心功能，提供了应用全生命周期的管理能力。

获取应用列表

端点：GET /apps

描述：获取所有已安装的应用

参数：

• endpointId（可选）：指定端点ID，若未设置则获取本地端点的应用

响应：返回应用列表，每个应用包含ID、名称、状态、版本等信息

示例：

curl -X GET "http://your-websoft9-server/api/v1/apps" -H "Authorization: Bearer your-jwt-token"

安装应用

端点：POST /apps/install

描述：在指定端点上安装应用

参数：

• appInstall：应用安装信息，包括应用ID、版本、配置等
• endpointId（可选）：指定端点ID，若未设置则安装在本地端点

响应：返回安装状态信息

示例：

curl -X POST "http://your-websoft9-server/api/v1/apps/install" -H "Content-Type: application/json" -H "Authorization: Bearer your-jwt-token" -d '{"app_id": "wordpress", "version": "5.8.1", "config": {"domain": "blog.example.com"}}'

启动/停止/重启应用

端点：

• POST /apps/{app_id}/start：启动应用
• POST /apps/{app_id}/stop：停止应用
• POST /apps/{app_id}/restart：重启应用

描述：控制应用的运行状态

参数：

• app_id：应用ID
• endpointId（可选）：指定端点ID

响应：返回操作结果

卸载应用

端点：DELETE /apps/{app_id}/uninstall

描述：卸载指定应用

参数：

• app_id：应用ID
• endpointId（可选）：指定端点ID
• purge_data：是否清除应用数据（布尔值）

响应：返回卸载结果

备份管理API

备份管理API提供了应用数据的备份和恢复功能，确保数据安全。

创建备份

端点：POST /backup/{app_id}

描述：为指定应用创建备份

参数：

• app_id：应用ID

响应：返回备份创建结果

列出备份

端点：GET /backup/snapshots

描述：列出所有备份或按应用ID筛选备份

参数：

• app_id（可选）：应用ID，用于筛选备份

响应：返回备份列表

恢复备份

端点：POST /backup/restore/{app_id}/{snapshot_id}

描述：将指定备份恢复到应用

参数：

• app_id：应用ID
• snapshot_id：备份ID

响应：返回恢复结果

代理管理API

代理管理API用于配置域名代理和SSL证书，实现应用的外部访问。

创建代理

端点：POST /proxys/{app_id}

描述：为应用创建域名代理

参数：

• app_id：应用ID
• domain_names：域名列表
• endpointId（可选）：指定端点ID

响应：返回代理配置结果

获取SSL证书

端点：GET /proxys/ssl/certificates

描述：获取所有SSL证书

响应：返回SSL证书列表

API使用最佳实践

错误处理

Websoft9 API使用标准的HTTP状态码表示请求结果：

• 200：请求成功
• 400：请求参数错误
• 401：未授权
• 404：资源不存在
• 500：服务器内部错误

错误响应格式如下：

{ "status_code": 400, "message": "错误信息", "details": "详细错误描述" }

批量操作

对于需要批量处理的场景，可以结合多个API端点实现复杂的自动化流程。例如，批量部署多个应用：

1. 调用GET /apps/available/en获取可用应用列表
2. 遍历列表，对需要部署的应用调用POST /apps/install
3. 调用GET /apps检查部署状态

监控与日志

Websoft9 API提供了日志流功能，可用于实时监控应用部署和操作过程。例如，在应用重新部署时，可以通过流式响应获取实时日志：

curl -X PUT "http://your-websoft9-server/api/v1/apps/{app_id}/redeploy?pullImage=true" -H "Authorization: Bearer your-jwt-token"

总结

Websoft9 API为应用的自动化部署和管理提供了强大而灵活的工具集。通过本文介绍的API端点和使用方法，您可以轻松构建自定义的应用管理流程，实现高效的DevOps工作流。无论是简单的应用部署，还是复杂的自动化流程，Websoft9 API都能满足您的需求。

要深入了解Websoft9 API的更多细节，请参考项目中的API文档和源代码：

• API路由定义：apphub/src/api/v1/routers/
• API模型定义：apphub/src/schemas/
• 服务实现：apphub/src/services/

通过这些资源，您可以全面掌握Websoft9 API的使用，为您的项目带来更高效的应用管理体验。

【免费下载链接】websoft9Applications self-hosting and DevOps platform for running open source, web-based linux Panel of lite PaaS项目地址: https://gitcode.com/gh_mirrors/we/websoft9