Fastly API - 非官方 OpenAPI 规范

此仓库包含 Fastly API 的非官方 OpenAPI 3.0 规范。它是通过逆向工程公开可用的 API 文档创建的。

免责声明

这是一个非官方规范，未得到 Fastly 的认可、支持或保证。它可能不完整或包含不准确之处。该规范按“原样”提供，不附带任何形式的保证。

特性

• Fastly CDN API 的全面 OpenAPI 3.0 模式
• 详细的端点描述和示例
• 请求和响应对象的模式定义
• 支持所有主要的 Fastly API 功能：
  • 服务管理
  • 域名配置
  • 后端管理
  • VCL 操作
  • 缓存控制
  • 清除操作
  • 边缘字典
  • WAF 安全
  • 日志记录端点
  • 统计数据和指标
  • Compute@Edge

规范

此仓库包含两个 OpenAPI 规范：

fastly-openapi.yaml

Fastly API 的完整规范，包含所有端点、参数和模式。这对于全面的 API 文档和客户端生成非常有用。

fastly-openapi-mcp.yaml

一个专门为 AI 代理交互优化的 API 子集。该规范：

• 仅包含用于常见 Fastly 任务的最常用端点
• 专注于日常管理所需的核心操作
• 保持详细描述和示例，以优化 AI 理解
• 优先考虑在对话界面中最有用的端点
• 采用与常见用户工作流程相匹配的任务型组织方式

MCP 版本非常适合与需要通过自然语言接口与 Fastly 交互的 AI 助手和工具集成。

使用方法

查看文档

您可以使用以下工具从这些规范生成交互式文档：

• Redoc
• Swagger UI

示例：
bash

对于完整的 API

npx @redocly/cli preview-docs fastly-openapi.yaml

对于 AI 优化的子集

npx @redocly/cli preview-docs fastly-openapi-mcp.yaml

验证

要验证这些规范：

bash

对于完整的 API

npx @stoplight/spectral-cli lint fastly-openapi.yaml

对于 AI 优化的子集

npx @stoplight/spectral-cli lint fastly-openapi-mcp.yaml

代码生成

可以使用 OpenAPI 代码生成器根据这些规范生成各种编程语言的客户端库：

bash

对于完整的 API

npx @openapitools/openapi-generator-cli generate -i fastly-openapi.yaml -g javascript -o ./client

对于 AI 优化的子集

npx @openapitools/openapi-generator-cli generate -i fastly-openapi-mcp.yaml -g javascript -o ./client-mcp

代理就绪

这两个规范都设计为“代理就绪”——优化了与 AI 代理和工具的使用。它们遵循机器可读性的最佳实践：

• 详细的操作描述
• 一致的命名模式
• 完整的模式文档
• 所有操作的示例

MCP 版本进一步增强了代理就绪性，包括：

• 为常见任务精选高价值端点
• 与用户意图对齐的任务导向型组织方式
• 针对对话上下文增强的描述
• 移除了在日常使用中很少出现的专业端点
• 在 AI 上下文中优化以减少令牌消耗

有关 MCP 规范的具体用例，请参阅 subset.md，其中概述了常见的对话任务及其对应的 API 工作流。

资源

• Fastly API 文档
• OpenAPI 规范
• Spectral - OpenAPI Linter