https://github.com/speakeasy-api/apitizing-burgers
https://github.com/speakeasy-api/apitizing-burgers
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/speakeasy-api/apitizing-burgers
- Owner: speakeasy-api
- Created: 2023-07-19T21:50:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-04T20:48:39.000Z (11 months ago)
- Last Synced: 2026-01-15T16:15:20.313Z (6 months ago)
- Language: Python
- Size: 214 KB
- Stars: 0
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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:
```bash
pip install "fastapi[all]"
```
3. Clone this repo:
```bash
git clone git@github.com:ritza-co/apitizing-burgers.git
```
## Run FastAPI server
1. In the `app` directory, run:
```bash
uvicorn main:app --reload
```
2. Open this link in your browser: [http://127.0.0.1:8000/docs](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](https://speakeasyapi.dev/docs/product-reference/speakeasy-cli/getting-started/) guide.
On macOS, you can install Speakeasy using Homebrew.
In your terminal, run:
```bash
brew install speakeasy-api/homebrew-tap/speakeasy
```
## Regenerate the `openapi.yaml`, `openapi.json` and the client SDK
In the project's directory, run:
```bash
./gen.sh
```