完整 API 参考

完整的 sh0 API，180+ 个端点、交互式浏览器和可下载的 OpenAPI 规范，用于代码生成。

交互式 API 浏览器

探索 sh0 API 最简单的方式是通过交互式 API 浏览器，可在以下位置访问：

• 控制台：在 sh0 控制台的侧边栏中导航至 API Docs。
• 网站：访问 sh0 网站上的 /api。

浏览器允许您：

• 按类别浏览所有端点
• 查看请求参数、头和请求体 Schema
• 查看每个端点的示例响应
• 直接从浏览器尝试端点（连接到 sh0 实例时）
• 复制任意端点的 curl 命令

OpenAPI 规范

sh0 暴露了一个完整的 OpenAPI 3.1 规范，描述每个端点、参数、请求体和响应类型。规范使用 utoipa 从 Rust 源代码自动生成，确保始终准确和最新。

规范可在以下位置获取：

# JSON format
curl https://your-server:9000/api/openapi.json

# YAML format
curl https://your-server:9000/api/openapi.yaml

端点分组

API 按逻辑分组。以下是主要端点类别的概述：

应用

管理应用生命周期——创建、配置、启动、停止、重启和删除应用。

部署

触发部署、查看构建日志、回滚和管理部署历史。

域名与 SSL

添加自定义域名、验证 DNS 和管理 SSL 证书。

数据库

配置数据库、管理备份和获取连接字符串。

其他端点

API 还涵盖以下资源类别：

下载 OpenAPI 规范

您可以下载 OpenAPI 规范，用于文档工具、测试框架或代码生成器。

# Download as JSON
curl -o sh0-openapi.json https://your-server:9000/api/openapi.json

# Download as YAML
curl -o sh0-openapi.yaml https://your-server:9000/api/openapi.yaml

规范文件可以导入以下工具：

• Postman：导入规范以创建预配置所有端点的集合。
• Insomnia：导入以创建交互式 API 工作区。
• Swagger UI：托管您自己的交互式 API 文档。
• Redocly：生成精美的 API 文档。

配合代码生成器使用

OpenAPI 规范可以与代码生成器配合使用，以任何语言创建类型化的 API 客户端：

TypeScript 客户端（使用 openapi-typescript）：

npx openapi-typescript https://your-server:9000/api/openapi.json \
  -o ./src/lib/api/sh0-types.ts

Python 客户端（使用 openapi-python-client）：

pip install openapi-python-client
openapi-python-client generate \
  --url https://your-server:9000/api/openapi.json

Go 客户端（使用 oapi-codegen）：

go install github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen@latest
oapi-codegen -package sh0 sh0-openapi.json > sh0_client.go