ritza-co / apitizing-burgers

Speakeasy is the fastest way to ship developer experience for your APIs.
speakeasyapi.dev

APItizing Burgers API: an example API to manage burgers and orders in a restaurant

This example API demonstrates Speakeasy's recommended practices for generating clear OpenAPI specifications.

Install FastAPI

To install and run this example, you'll need a Python virtualenv with FastAPI installed.

1. Activate your Python virtualenv.
2. Install FastAPI. Run the following in the terminal:

   pip install "fastapi[all]"

3. Clone this repo:

   git clone [email protected]:ritza-co/apitizing-burgers.git

Run FastAPI server

1. In the app directory, run:

   uvicorn main:app --reload

2. Open this link in your browser: http://127.0.0.1:8000/docs

Install Speakeasy

To save OpenAPI output to a file and regenerate the SDK with Speakeasy, first install Speakeasy by following the Speakeasy Getting Started guide.

On macOS, you can install Speakeasy using Homebrew.

In your terminal, run:

brew install speakeasy-api/homebrew-tap/speakeasy

Regenerate the openapi.yaml, openapi.json and the client SDK

In the project's directory, run:

./gen.sh