mirror of
https://github.com/fastapi/fastapi.git
synced 2025-12-30 17:50:39 -05:00
70a51b3aff
* root_path included in servers object instead of path prefix * ♻️ Refactor implementation of auto-including root_path in OpenAPI servers * 📝 Update docs and examples for Behind a Proxy, including servers * 📝 Update Extending OpenAPI as openapi_prefix is no longer needed * ✅ Add extra tests for root_path in servers and root_path_in_servers=False * 🍱 Update security docs images with relative token URL * 📝 Update security docs with relative token URL * 📝 Update example sources with relative token URLs * ✅ Update tests with relative tokens Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
78 lines
2.2 KiB
Python
78 lines
2.2 KiB
Python
from typing import Optional
|
|
|
|
from fastapi import FastAPI, Security
|
|
from fastapi.security import OAuth2AuthorizationCodeBearer
|
|
from fastapi.testclient import TestClient
|
|
|
|
app = FastAPI()
|
|
|
|
oauth2_scheme = OAuth2AuthorizationCodeBearer(
|
|
authorizationUrl="authorize", tokenUrl="token", auto_error=True
|
|
)
|
|
|
|
|
|
@app.get("/items/")
|
|
async def read_items(token: Optional[str] = Security(oauth2_scheme)):
|
|
return {"token": token}
|
|
|
|
|
|
client = TestClient(app)
|
|
|
|
openapi_schema = {
|
|
"openapi": "3.0.2",
|
|
"info": {"title": "FastAPI", "version": "0.1.0"},
|
|
"paths": {
|
|
"/items/": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {"application/json": {"schema": {}}},
|
|
}
|
|
},
|
|
"summary": "Read Items",
|
|
"operationId": "read_items_items__get",
|
|
"security": [{"OAuth2AuthorizationCodeBearer": []}],
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"securitySchemes": {
|
|
"OAuth2AuthorizationCodeBearer": {
|
|
"type": "oauth2",
|
|
"flows": {
|
|
"authorizationCode": {
|
|
"authorizationUrl": "authorize",
|
|
"tokenUrl": "token",
|
|
"scopes": {},
|
|
}
|
|
},
|
|
}
|
|
}
|
|
},
|
|
}
|
|
|
|
|
|
def test_openapi_schema():
|
|
response = client.get("/openapi.json")
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == openapi_schema
|
|
|
|
|
|
def test_no_token():
|
|
response = client.get("/items")
|
|
assert response.status_code == 401, response.text
|
|
assert response.json() == {"detail": "Not authenticated"}
|
|
|
|
|
|
def test_incorrect_token():
|
|
response = client.get("/items", headers={"Authorization": "Non-existent testtoken"})
|
|
assert response.status_code == 401, response.text
|
|
assert response.json() == {"detail": "Not authenticated"}
|
|
|
|
|
|
def test_token():
|
|
response = client.get("/items", headers={"Authorization": "Bearer testtoken"})
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == {"token": "testtoken"}
|