Examples

Learning by Doing

The best way to understand firestone's capabilities is to see it in action. This section provides a collection of practical, real-world examples that illustrate how to define resources and generate APIs, CLIs, and UIs for various use cases.

Each example comes with:

Resource Blueprint: The YAML definition of the resources.
Generation Commands: The firestone commands used to produce the output.
Output Snippets: Key parts of the generated OpenAPI spec, CLI output, or Streamlit UI.
Explanation: A breakdown of the concepts demonstrated in the example.

By working through these examples, you'll gain a deeper understanding of how to apply firestone to your own projects and solve common API design challenges.

What You'll Learn Here

This section showcases practical applications of firestone for different scenarios.

1. Addressbook Tutorial

A classic CRUD example demonstrating basic resource definition, OpenAPI generation, and CLI tool creation.

2. Blog API Example

Illustrates how to define multiple, related resources (posts, comments) and generate a multi-resource API.

3. Simple CRUD API

A quick, minimal example focusing solely on the fundamental Create, Read, Update, Delete operations.

4. Multi-Resource API

Deeper dive into managing and generating APIs from several interconnected resource definitions.

Next Steps

Ready to get hands-on?

Next: Start with the comprehensive Addressbook Tutorial.