Fastly API — спецификация OpenAPI
Этот репозиторий содержит полную неофициальную спецификацию OpenAPI 3.0 для API Fastly , созданную путем обратного проектирования общедоступной документации API. Он содержит значительно улучшенную документацию по сравнению с официальными веб-документами, с подробными описаниями, примерами и структурированными схемами, оптимизированными как для разработчиков-людей, так и для агентов ИИ.
Ключевые компоненты
Этот проект предоставляет три ключевых ресурса для работы с API Fastly:
- Полная спецификация OpenAPI (
fastly-openapi.yaml ) — всеобъемлющая схема OpenAPI 3.0 для всех конечных точек API Fastly - Спецификация, оптимизированная для ИИ (
fastly-openapi-mcp.yaml ) — оптимизированное подмножество, оптимизированное для использования агентом ИИ - Сервер протокола контекста модели (
fastly-mcp-server/ ) — реализация сервера MCP, которая позволяет моделям ИИ взаимодействовать с Fastly через стандартизированный протокол.
MCP-сервер для интеграции ИИ
Репозиторий включает в себя полный сервер Model Context Protocol (MCP) для Fastly, доступный на NPM:
# Install globally
npm install -g fastly-mcp-server
# Or run directly
npx fastly-mcp-server run
Этот сервер MCP позволяет помощникам и агентам на базе искусственного интеллекта:
- Взаимодействуйте с сервисами Fastly на естественном языке
- Управление конфигурациями CDN, настройками кэширования и функциями безопасности
- Выполнение очистки контента, сбора статистики и развертывания сервиса
- Доступ ко всем основным функциям Fastly через стандартизированный интерфейс
Подробные примеры использования и параметры конфигурации см. в каталоге fastly-mcp-server.
Отказ от ответственности
Это неофициальная спецификация, которая не одобрена, не поддерживается и не гарантируется Fastly. Она может быть неполной или содержать неточности. Спецификация предоставляется «как есть» без каких-либо гарантий.
Функции
- Комплексная схема OpenAPI 3.0 для API CDN Fastly
- Расширенная документация , которая превосходит официальную веб-документацию по ясности и детализации
- Схемы, оптимизированные для ИИ, специально разработанные для использования крупными языковыми моделями и агентами ИИ
- Подробные описания конечных точек с эксплуатационным контекстом и примерами
- Полные определения схем для всех объектов запросов и ответов
- Поддержка всех основных функций API Fastly:
- Управление услугами
- Конфигурация домена
- Управление бэкэндом
- Манипуляция VCL
- Управление кэшем
- Операции по очистке
- Словари Edge
- Безопасность ВАФ
- Регистрация конечных точек
- Статистика и метрики
- Вычислить@Edge
Технические характеристики
Этот репозиторий содержит две спецификации OpenAPI:
fastly-openapi.yaml
Полная спецификация API Fastly, содержащая все конечные точки, параметры и схемы. Эта спецификация:
- Предоставляет более подробную и структурированную документацию, чем официальные веб-документы.
- Включает подробные описания, поясняющие контекст использования, а не только параметры.
- Содержит последовательные примеры для всех операций и схем данных.
- Полезен для комплексной документации API и создания клиентов.
fastly-openapi-mcp.yaml
Оптимизированное подмножество API, специально оптимизированное для взаимодействия с агентом ИИ. Эта спецификация:
- Содержит только наиболее часто используемые конечные точки для общих задач Fastly.
- Сосредоточение на основных операциях, необходимых для повседневного управления
- Поддерживает подробные описания и примеры, оптимизированные для понимания ИИ
- Приоритизирует конечные точки, которые наиболее полезны в диалоговых интерфейсах
- Соответствует организации на основе задач, соответствующей общим рабочим процессам пользователей.
- Снижает потребление токенов для контекстов ИИ, одновременно увеличивая полезность
Версия MCP идеально подходит для интеграции с помощниками на базе искусственного интеллекта и инструментами, которым необходимо взаимодействовать с Fastly через интерфейсы на естественном языке.
Использование
Просмотр документации
Вы можете создать интерактивную документацию на основе этих спецификаций, используя такие инструменты, как:
Примеры:
# For the complete API
npx @redocly/cli preview-docs fastly-openapi.yaml
# For the AI-optimized subset
npx @redocly/cli preview-docs fastly-openapi-mcp.yaml
Проверка
Для проверки спецификаций:
# For the complete API
npx @stoplight/spectral-cli lint fastly-openapi.yaml
# Or use swagger-cli
npx swagger-cli validate fastly-openapi.yaml
# For the AI-optimized subset
npx @stoplight/spectral-cli lint fastly-openapi-mcp.yaml
Генерация кода
Эти спецификации можно использовать с генераторами кода OpenAPI для создания клиентских библиотек на различных языках программирования:
# For the complete API
npx @openapitools/openapi-generator-cli generate -i fastly-openapi.yaml -g javascript -o ./client
# For the AI-optimized subset
npx @openapitools/openapi-generator-cli generate -i fastly-openapi-mcp.yaml -g javascript -o ./client-mcp
Готовность агента
Обе спецификации разработаны как "готовые к агентам" - оптимизированные для использования с агентами и инструментами ИИ. Они следуют лучшим практикам для машинного чтения:
- Подробные описания операций с более высокой плотностью информации, чем в официальных документах
- Последовательные шаблоны именования для связанных конечных точек
- Полная документация схемы с подробным описанием свойств
- Примеры всех операций и компонентов схемы
- Правильно структурированные ссылки и связи между компонентами
Версия MCP еще больше повышает готовность агентов к работе с:
- Специально подобранные конечные точки с высокой ценностью для решения распространенных задач
- Организация, ориентированная на выполнение задач и соответствующая намерениям пользователя
- Расширенные описания, ориентированные на разговорные контексты
- Удаление специализированных конечных точек, которые редко встречаются в повседневном использовании.
- Оптимизировано для снижения потребления токенов в контексте ИИ
Конкретные варианты использования спецификации MCP см. в subset.md , где описаны общие диалоговые задачи и соответствующие рабочие процессы API.
Использование сервера MCP
Чтобы использовать сервер MCP с конфигурацией вашего помощника на основе искусственного интеллекта:
Булочка (рекомендуется)
{
"mcpServers": {
"fastly api": {
"command": "bunx",
"args": ["fastly-mcp-server@latest", "run"],
"env": {
"API_KEY_APIKEYAUTH": "your-fastly-api-key"
}
}
}
}
Node.js
{
"mcpServers": {
"fastly": {
"command": "npx",
"args": ["-y", "fastly-mcp-server@latest", "run"],
"env": {
"API_KEY_APIKEYAUTH": "your-fastly-api-key"
}
}
}
}
Примечание : Bun является предпочтительной средой выполнения для fastly-mcp-server из-за ее превосходной производительности и времени запуска.
Более подробную информацию о настройке и использовании смотрите в документации fastly-mcp-server .
Ресурсы