mirror of
https://github.com/fastapi/fastapi.git
synced 2026-01-20 11:58:24 -05:00
0ac9b3ee5c
* ✨ Re-export main features used from Starlette to simplify developer's code * ♻️ Refactor Starlette exports * ♻️ Refactor tutorial examples to use re-exported utils from Starlette * 📝 Add examples for all middlewares * 📝 Add new docs for middlewares * 📝 Add examples for custom responses * 📝 Extend docs for custom responses * 📝 Update docs and add notes explaining re-exports from Starlette everywhere * 🍱 Update screenshot for HTTP status * 🔧 Update MkDocs config with new content * ♻️ Refactor tests to use re-exported utils from Starlette * ✨ Re-export WebSocketDisconnect from Starlette for tests * ✅ Add extra tests for extra re-exported middleware * ✅ Add tests for re-exported responses from Starlette * ✨ Add docs about mounting WSGI apps * ➕ Add Flask as a dependency to test WSGIMiddleware * ✅ Test WSGIMiddleware example
82 lines
2.6 KiB
Python
82 lines
2.6 KiB
Python
from base64 import b64encode
|
|
from typing import Optional
|
|
|
|
from fastapi import FastAPI, Security
|
|
from fastapi.security import HTTPBasic, HTTPBasicCredentials
|
|
from fastapi.testclient import TestClient
|
|
from requests.auth import HTTPBasicAuth
|
|
|
|
app = FastAPI()
|
|
|
|
security = HTTPBasic(auto_error=False)
|
|
|
|
|
|
@app.get("/users/me")
|
|
def read_current_user(credentials: Optional[HTTPBasicCredentials] = Security(security)):
|
|
if credentials is None:
|
|
return {"msg": "Create an account first"}
|
|
return {"username": credentials.username, "password": credentials.password}
|
|
|
|
|
|
client = TestClient(app)
|
|
|
|
openapi_schema = {
|
|
"openapi": "3.0.2",
|
|
"info": {"title": "FastAPI", "version": "0.1.0"},
|
|
"paths": {
|
|
"/users/me": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {"application/json": {"schema": {}}},
|
|
}
|
|
},
|
|
"summary": "Read Current User",
|
|
"operationId": "read_current_user_users_me_get",
|
|
"security": [{"HTTPBasic": []}],
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"securitySchemes": {"HTTPBasic": {"type": "http", "scheme": "basic"}}
|
|
},
|
|
}
|
|
|
|
|
|
def test_openapi_schema():
|
|
response = client.get("/openapi.json")
|
|
assert response.status_code == 200
|
|
assert response.json() == openapi_schema
|
|
|
|
|
|
def test_security_http_basic():
|
|
auth = HTTPBasicAuth(username="john", password="secret")
|
|
response = client.get("/users/me", auth=auth)
|
|
assert response.status_code == 200
|
|
assert response.json() == {"username": "john", "password": "secret"}
|
|
|
|
|
|
def test_security_http_basic_no_credentials():
|
|
response = client.get("/users/me")
|
|
assert response.status_code == 200
|
|
assert response.json() == {"msg": "Create an account first"}
|
|
|
|
|
|
def test_security_http_basic_invalid_credentials():
|
|
response = client.get(
|
|
"/users/me", headers={"Authorization": "Basic notabase64token"}
|
|
)
|
|
assert response.status_code == 401
|
|
assert response.headers["WWW-Authenticate"] == "Basic"
|
|
assert response.json() == {"detail": "Invalid authentication credentials"}
|
|
|
|
|
|
def test_security_http_basic_non_basic_credentials():
|
|
payload = b64encode(b"johnsecret").decode("ascii")
|
|
auth_header = f"Basic {payload}"
|
|
response = client.get("/users/me", headers={"Authorization": auth_header})
|
|
assert response.status_code == 401
|
|
assert response.headers["WWW-Authenticate"] == "Basic"
|
|
assert response.json() == {"detail": "Invalid authentication credentials"}
|