基本能力
产品定位
Fastly API 非官方 OpenAPI 规范旨在为 Fastly API 提供一个全面的 OpenAPI 3.0 描述,适用于开发者、AI 代理和工具集成。
核心功能
- 全面的 Fastly CDN API 的 OpenAPI 3.0 模式
- 详细的端点描述和示例
- 请求和响应对象的模式定义
- 支持 Fastly API 的所有主要功能,包括服务管理、域配置、后端管理、VCL 操作、缓存控制、清除操作、边缘字典、WAF 安全、日志端点、统计和指标、Compute@Edge 等。
适用场景
- 开发者需要快速理解和使用 Fastly API
- AI 代理需要与 Fastly API 交互
- 工具集成需要生成客户端库或文档
工具列表
- Redoc: 用于生成交互式文档
- Swagger UI: 用于生成交互式文档
- Spectral: 用于 OpenAPI 规范验证
- OpenAPI Generator: 用于生成客户端库
使用教程
使用依赖
安装 Node.js 和 npm。
安装教程
无需安装,直接使用 YAML 文件。
调试方式
使用以下命令生成文档或验证规范:
# 生成完整 API 的文档
npx @redocly/cli preview-docs fastly-openapi.yaml
# 生成 AI 优化子集的文档
npx @redocly/cli preview-docs fastly-openapi-mcp.yaml
# 验证完整 API 的规范
npx @stoplight/spectral-cli lint fastly-openapi.yaml
# 验证 AI 优化子集的规范
npx @stoplight/spectral-cli lint fastly-openapi-mcp.yaml
# 生成客户端库
npx @openapitools/openapi-generator-cli generate -i fastly-openapi.yaml -g javascript -o ./client
npx @openapitools/openapi-generator-cli generate -i fastly-openapi-mcp.yaml -g javascript -o ./client-mcp
