Skip to content

fix: README typos #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stv8 merged 1 commit into from
Dec 22, 2025
Merged

fix: README typos #112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ def get(query: QueryModel):
### Example 2: URL path parameter

```python
# Example 2: URL path parameter only
@app.route("/character/<character_id>/", methods=["GET"])
@validate()
def get_character(character_id: int):
Expand All @@ -164,7 +165,7 @@ class RequestBodyModel(BaseModel):
name: str
nickname: Optional[str] = None

# Example2: request body only
# Example 3: request body only
@app.route("/", methods=["POST"])
@validate()
def post(body: RequestBodyModel):
Expand All @@ -182,7 +183,7 @@ def post(body: RequestBodyModel):
### Example 4: BOTH query paramaters and request body

```python
# Example 3: both query paramters and request body
# Example 4: both query paramters and request body
@app.route("/both", methods=["POST"])
@validate()
def get_and_post(body: RequestBodyModel, query: QueryModel):
Expand All @@ -207,7 +208,7 @@ class RequestFormDataModel(BaseModel):
name: str
nickname: Optional[str] = None

# Example2: request body only
# Example 5: request form only
@app.route("/", methods=["POST"])
@validate()
def post(form: RequestFormDataModel):
Expand Down
Loading