Browse Source

Added a small explanation to improve clarity for the basic FastAPI example.

Changes
Explained how @app.get("/") works
Clarified function execution
Explained automatic JSON response
Reason

This helps beginners better understand how routing works in FastAPI.
pull/15479/head
Susan Irene 2 months ago
committed by GitHub
parent
commit
8ca62a5c81
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 7
      docs/en/docs/index.md

7
docs/en/docs/index.md

@ -226,6 +226,13 @@ app = FastAPI()
async def read_root():
return {"Hello": "World"}
#### Explanation
- `@app.get("/")` defines an HTTP GET endpoint for the root URL (`/`)
- When a client accesses this URL, the function `read_root()` is executed
- The returned dictionary is automatically converted into a JSON response
This shows how FastAPI maps routes directly to Python functions.
@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str | None = None):

Loading…
Cancel
Save