Skip to content
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

Easier to learn README.md #23

Merged
merged 17 commits into from
Jan 31, 2021
Merged

Easier to learn README.md #23

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
e7298c2
made it simple to run app, app.run()
Jan 30, 2021
5cf736b
README.md:mod:first endpoint
Jan 30, 2021
a805e0e
README.md:mod:first endpoint now ready
Jan 30, 2021
39aa0ae
README.md:mod:example more clarification
Jan 30, 2021
d2c3b3e
README.me:mod:example1:clear
Jan 30, 2021
ff24834
README.md:example 2:ready
Jan 30, 2021
b270923
README.md:add:example 3:ready
Jan 30, 2021
f790376
full example now ready
Jan 30, 2021
697131e
removed comments
Jan 30, 2021
cf6bdc0
README.md:add:curl
Jan 30, 2021
5afece7
README.md:add:rearranged examples
Jan 30, 2021
77ea712
README.md:add:example 2 and 3
Jan 30, 2021
0c67f05
README.md:add:rearranged examples
Jan 30, 2021
5d8c3d6
readme.py:created
Jan 30, 2021
9c9c61a
readme.py:filled
Jan 30, 2021
ae7c42b
readme.py:add:curl
Jan 30, 2021
bdc5dd6
created example app
Jan 30, 2021
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
Prev Previous commit
Next Next commit
README.me:mod:example1:clear
  • Loading branch information
OmarThinks committed Jan 30, 2021
commit d2c3b3eb82577f354586c6092465cf680f9be8cf
26 changes: 12 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ from flask_pydantic import validate

app = Flask("flask_pydantic_app")

# Request body expectation as a pydantic model
class BodyModel(BaseModel):
# Request body expectations as a pydantic model
class RequestBodyModel(BaseModel):
name: str
nickname: Optional[str]

# API response expectation as a pydantic model
# API response expectations as a pydantic model
class ResponseModel(BaseModel):
id: int
age: int
Expand All @@ -68,29 +68,27 @@ Example 1:
receive inputs from request body
"""
@app.route("/", methods=["POST"])
@validate() # Welcome to flask_pydantic
def post(body:BodyModel): # expected request body
name = body.name
nickname = body.nickname
@validate() # To apply flask_pydantic to this endpoint
def post(body:RequestBodyModel): # expected request body
name_ = body.name
nickname_ = body.nickname
# Now 'name' and 'nickname' are
# received and, validated and sanitized from the request body
# received, validated and sanitized from the request body

# save model to DB
id = 1 # we should have got it from db
age = 1 # we should have got it from db
id_ = 1; age_ = 1 # we should have got them from db

return ResponseModel(
id=id, age=age, name=name,
nickname=nickname,
)
id=id_, age=age_, name=name_, nickname=nickname_
)

class QueryModel(BaseModel):
age: int

# First example Endpoint, Receive request body
@app.route("/", methods=["GET"])
@validate()
def get(body:BodyModel):
def get(body:RequestBodyModel):
name = body.name
nickname = body.nickname
# Now 'name' and 'nickname' are
Expand Down