Fastly API OpenAPI Specification logo

Fastly API OpenAPI Specification

by jedisct1

This repository provides an unofficial OpenAPI 3.0 specification for the Fastly API, created by reverse engineering the publicly available API documentation. It offers comprehensive documentation and client generation capabilities.

View on GitHub

Last updated: N/A

What is Fastly API OpenAPI Specification?

This is an unofficial OpenAPI 3.0 specification for the Fastly API. It provides a structured representation of the API's endpoints, parameters, and schemas, enabling documentation generation, code generation, and integration with AI agents.

How to use Fastly API OpenAPI Specification?

The specifications can be used to generate interactive documentation using tools like Redoc and Swagger UI. They can also be validated using Spectral and used with OpenAPI code generators to create client libraries in various programming languages. The MCP version is optimized for AI agent interaction.

Key features of Fastly API OpenAPI Specification

  • Comprehensive OpenAPI 3.0 schema for Fastly's CDN API

  • Detailed endpoint descriptions and examples

  • Schema definitions for request and response objects

  • Optimized version for AI agent interaction (MCP)

  • Agent Readiness

Use cases of Fastly API OpenAPI Specification

  • Generating interactive API documentation

  • Validating API specifications

  • Generating client libraries in various programming languages

  • Integrating Fastly API with AI assistants and tools

  • Automating Fastly service management tasks

FAQ from Fastly API OpenAPI Specification

Is this specification official?

No, this is an unofficial specification and is not endorsed, supported, or guaranteed by Fastly.

What is the difference between fastly-openapi.yaml and fastly-openapi-mcp.yaml?

fastly-openapi.yaml is the complete specification of the Fastly API, while fastly-openapi-mcp.yaml is a streamlined subset optimized for AI agent interaction.

What tools can I use to view the documentation?

You can use tools like Redoc and Swagger UI to generate interactive documentation from these specifications.

How can I validate the specifications?

You can validate the specifications using Spectral.

Can I use this to generate client libraries?

Yes, these specifications can be used with OpenAPI code generators to create client libraries in various programming languages.