Automatic API documentation (Swagger UI) in FastAPI - Step-by-Step Execution

Concept Flow - Automatic API documentation (Swagger UI)

Define FastAPI app

↓

Create API endpoints

↓

Run FastAPI server

↓

Access /docs URL

↓

Swagger UI loads

↓

View interactive API docs

↓

Try API calls from UI

This flow shows how FastAPI automatically generates interactive API docs using Swagger UI when you run the server and visit /docs.

Execution Sample

FastAPI

from fastapi import FastAPI
app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id}

Defines a FastAPI app with one GET endpoint that returns the item_id passed in the URL.

Execution Table

Step	Action	Evaluation	Result
1	Define FastAPI app	app = FastAPI()	App instance created
2	Define GET endpoint /items/{item_id}	Function read_item registered	Endpoint ready
3	Run FastAPI server	Server starts listening	API available at localhost
4	Open browser at /docs	Request Swagger UI page	Swagger UI loads
5	Swagger UI reads OpenAPI schema	Auto-generated from app	Interactive docs shown
6	User tries GET /items/5 in UI	Request sent to server	Response {"item_id":5} shown
7	User tries GET /items/abc in UI	Invalid int parameter	Error response shown
8	Exit	User closes browser or stops server	Docs no longer accessible

💡 User stops server or closes docs page, ending interaction

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	After Step 6	Final
app	undefined	FastAPI instance	FastAPI instance with endpoint	Running server instance	Running server instance	Stopped or running depending on user
item_id	undefined	undefined	undefined	undefined	5 (from UI request)	undefined

Key Moments - 3 Insights

Why does the /docs page show the API without extra code?

FastAPI automatically generates OpenAPI schema from your endpoint definitions, which Swagger UI uses to build the docs (see execution_table step 5).

What happens if I enter a wrong type like a string instead of int for item_id?

FastAPI validates parameters and returns an error response automatically (see execution_table step 7).

Do I need to write any HTML or JavaScript for the docs?

No, FastAPI includes Swagger UI by default and serves it at /docs (see execution_table steps 4 and 5).

Visual Quiz - 3 Questions

Look at the execution table, what is the result of step 5?

A Server starts listening for requests

B User tries GET /items/5 in UI

C Swagger UI loads and shows interactive API docs

D Function read_item registered

💡 Hint

Check the 'Result' column in step 5 of the execution_table

At which step does the server start listening for requests?

A Step 2

B Step 3

C Step 6

D Step 1

💡 Hint

Look at the 'Action' and 'Result' columns in the execution_table

If you change the endpoint path to /products/{item_id}, which step changes in the execution table?

A Step 2 - Defining the GET endpoint

B Step 6 - Trying GET /items/5

C Step 4 - Opening /docs URL

D Step 7 - Invalid parameter error

💡 Hint

Changing the endpoint path affects the endpoint registration step

Concept Snapshot

FastAPI auto-generates API docs at /docs using Swagger UI.
Define endpoints with decorators like @app.get.
Run server, visit /docs to see interactive docs.
Docs show all endpoints and allow trying calls.
No extra code needed for docs.
Parameter validation and errors shown automatically.

Full Transcript

This visual execution shows how FastAPI creates automatic API documentation using Swagger UI. First, you define a FastAPI app and add endpoints with decorators. When you run the server, it listens for requests. Visiting the /docs URL loads Swagger UI, which reads the OpenAPI schema generated from your endpoints. This displays interactive API documentation where you can try API calls. FastAPI also validates parameters and shows errors if inputs are wrong. No extra code is needed to get this documentation. The execution table traces each step from app creation to user interaction with the docs.