OpenAPI Generation

Automating RESTful API Specifications

OpenAPI is the standard for describing RESTful APIs. firestone automates the creation of these specs from your resource blueprints, ensuring documentation always matches your data model.

1. OpenAPI Basics

How Firestone maps resources to OpenAPI concepts.

2. Generating Your First OpenAPI Spec

CLI commands for spec generation.

3. Understanding the OpenAPI Spec Structure

Deep dive into Tags, Paths, and Components mapping.

4. Swagger UI Integration

Instant visualization with --ui-server.

5. Advanced OpenAPI Features

Extensions (x-), custom response codes, and schema composition.

6. Validation Tools

Validating your output with Spectral and Redocly.


Pages in this section: