Browse Source
* ✨ Add support for declaring a Response parameter to set headers and cookies * ✅ Add source for docs and tests * 📝 Add docs for setting headers, cookies and status code * 📝 Add attribution to Hug for inspiring response parameterspull/306/head
Sebastián Ramírez
6 years ago
committed by
GitHub
GitHub
17 changed files with 229 additions and 13 deletions
@ -0,0 +1,15 @@ |
|||
from fastapi import FastAPI |
|||
from starlette.responses import Response |
|||
from starlette.status import HTTP_201_CREATED |
|||
|
|||
app = FastAPI() |
|||
|
|||
tasks = {"foo": "Listen to the Bar Fighters"} |
|||
|
|||
|
|||
@app.put("/get-or-create-task/{task_id}", status_code=200) |
|||
def get_or_create_task(task_id: str, response: Response): |
|||
if task_id not in tasks: |
|||
tasks[task_id] = "This didn't exist before" |
|||
response.status_code = HTTP_201_CREATED |
|||
return tasks[task_id] |
|||
@ -0,0 +1,10 @@ |
|||
from fastapi import FastAPI |
|||
from starlette.responses import Response |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.post("/cookie-and-object/") |
|||
def create_cookie(response: Response): |
|||
response.set_cookie(key="fakesession", value="fake-cookie-session-value") |
|||
return {"message": "Come to the dark side, we have cookies"} |
|||
@ -0,0 +1,10 @@ |
|||
from fastapi import FastAPI |
|||
from starlette.responses import Response |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.get("/headers-and-object/") |
|||
def get_headers(response: Response): |
|||
response.headers["X-Cat-Dog"] = "alone in the world" |
|||
return {"message": "Hello World"} |
|||
@ -0,0 +1,31 @@ |
|||
You probably read before that you can set a <a href="https://fastapi.tiangolo.com/tutorial/response-status-code/" target="_blank">default Response Status Code</a>. |
|||
|
|||
But in some cases you need to return a different status code than the default. |
|||
|
|||
## Use case |
|||
|
|||
For example, imagine that you want to return an HTTP status code of "OK" `200` by default. |
|||
|
|||
But if the data didn't exist, you want to create it, and return an HTTP status code of "CREATED" `201`. |
|||
|
|||
But you still want to be able to filter and convert the data you return with a `response_model`. |
|||
|
|||
For those cases, you can use a `Response` parameter. |
|||
|
|||
## Use a `Response` parameter |
|||
|
|||
You can declare a parameter of type `Response` in your *path operation function* (as you can do for cookies and headers). |
|||
|
|||
And then you can set the `status_code` in that *temporal* response object. |
|||
|
|||
```Python hl_lines="2 11 14" |
|||
{!./src/response_change_status_code/tutorial001.py!} |
|||
``` |
|||
|
|||
And then you can return any object you need, as you normally would (a `dict`, a database model, etc). |
|||
|
|||
And if you declared a `response_model`, it will still be used to filter and convert the object you returned. |
|||
|
|||
**FastAPI** will use that *temporal* response to extract the status code (also cookies and headers), and will put them in the final response that contains the value you returned, filtered by any `response_model`. |
|||
|
|||
You can also declare the `Response` parameter in dependencies, and set the status code in them. But have in mind that the last one to be set will win. |
|||
@ -0,0 +1,27 @@ |
|||
from fastapi import Depends, FastAPI |
|||
from starlette.responses import Response |
|||
from starlette.testclient import TestClient |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
async def response_status_setter(response: Response): |
|||
response.status_code = 201 |
|||
|
|||
|
|||
async def parent_dep(result=Depends(response_status_setter)): |
|||
return result |
|||
|
|||
|
|||
@app.get("/", dependencies=[Depends(parent_dep)]) |
|||
async def get_main(): |
|||
return {"msg": "Hello World"} |
|||
|
|||
|
|||
client = TestClient(app) |
|||
|
|||
|
|||
def test_dependency_set_status_code(): |
|||
response = client.get("/") |
|||
assert response.status_code == 201 |
|||
assert response.json() == {"msg": "Hello World"} |
|||
@ -0,0 +1,15 @@ |
|||
from starlette.testclient import TestClient |
|||
|
|||
from response_change_status_code.tutorial001 import app |
|||
|
|||
client = TestClient(app) |
|||
|
|||
|
|||
def test_path_operation(): |
|||
response = client.put("/get-or-create-task/foo") |
|||
print(response.content) |
|||
assert response.status_code == 200 |
|||
assert response.json() == "Listen to the Bar Fighters" |
|||
response = client.put("/get-or-create-task/bar") |
|||
assert response.status_code == 201 |
|||
assert response.json() == "This didn't exist before" |
|||
@ -0,0 +1,12 @@ |
|||
from starlette.testclient import TestClient |
|||
|
|||
from response_cookies.tutorial002 import app |
|||
|
|||
client = TestClient(app) |
|||
|
|||
|
|||
def test_path_operation(): |
|||
response = client.post("/cookie-and-object/") |
|||
assert response.status_code == 200 |
|||
assert response.json() == {"message": "Come to the dark side, we have cookies"} |
|||
assert response.cookies["fakesession"] == "fake-cookie-session-value" |
|||
@ -0,0 +1,12 @@ |
|||
from starlette.testclient import TestClient |
|||
|
|||
from response_headers.tutorial002 import app |
|||
|
|||
client = TestClient(app) |
|||
|
|||
|
|||
def test_path_operation(): |
|||
response = client.get("/headers-and-object/") |
|||
assert response.status_code == 200 |
|||
assert response.json() == {"message": "Hello World"} |
|||
assert response.headers["X-Cat-Dog"] == "alone in the world" |
|||
Loading…
Reference in new issue