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.py:filled
  • Loading branch information
OmarThinks committed Jan 30, 2021
commit 9c9c61a6a3a4daa3567faa59e2a3542412f03e21
52 changes: 52 additions & 0 deletions example_app/readme.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
from typing import Optional
from flask import Flask, request
from pydantic import BaseModel

from flask_pydantic import validate

app = Flask("flask_pydantic_app")

class RequestBodyModel(BaseModel):
name: str
nickname: Optional[str]


class QueryModel(BaseModel):
age: int

@app.route("/", methods=["GET"])
@validate()
def get(query:QueryModel):
age = query.age
return ResponseModel(
age=age,
id=0, name="abc", nickname="123"
)

class ResponseModel(BaseModel):
id: int
age: int
name: str
nickname: Optional[str]

@app.route("/", methods=["POST"])
@validate()
def post(body:RequestBodyModel):
name = body.name
nickname = body.nickname
return ResponseModel(
name=name, nickname=nickname,id=0, age=1000
)

@app.route("/both", methods=["POST"])
@validate()
def get_and_post(body:RequestBodyModel,query:QueryModel):
name = body.name # From request body
nickname = body.nickname # From request body
age = query.age # from query parameters
return ResponseModel(
age=age, name=name, nickname=nickname,
id=0
)

app.run(debug=True)