371 lines
14 KiB
Python
371 lines
14 KiB
Python
|
from typing import Optional
|
||
|
|
|
||
|
|
from dirty_equals import IsDict
|
||
|
|
from fastapi import FastAPI
|
||
|
|
from fastapi.responses import JSONResponse
|
||
|
|
from fastapi.testclient import TestClient
|
||
|
|
from pydantic import BaseModel
|
||
|
|
|
||
|
|
app = FastAPI()
|
||
|
|
|
||
|
|
|
||
|
|
class Item(BaseModel):
|
||
|
|
name: str
|
||
|
|
price: Optional[float] = None
|
||
|
|
|
||
|
|
|
||
|
|
@app.api_route("/items/{item_id}", methods=["GET"])
|
||
|
|
def get_items(item_id: str):
|
||
|
|
return {"item_id": item_id}
|
||
|
|
|
||
|
|
|
||
|
|
def get_not_decorated(item_id: str):
|
||
|
|
return {"item_id": item_id}
|
||
|
|
|
||
|
|
|
||
|
|
app.add_api_route("/items-not-decorated/{item_id}", get_not_decorated)
|
||
|
|
|
||
|
|
|
||
|
|
@app.delete("/items/{item_id}")
|
||
|
|
def delete_item(item_id: str, item: Item):
|
||
|
|
return {"item_id": item_id, "item": item}
|
||
|
|
|
||
|
|
|
||
|
|
@app.head("/items/{item_id}")
|
||
|
|
def head_item(item_id: str):
|
||
|
|
return JSONResponse(None, headers={"x-fastapi-item-id": item_id})
|
||
|
|
|
||
|
|
|
||
|
|
@app.options("/items/{item_id}")
|
||
|
|
def options_item(item_id: str):
|
||
|
|
return JSONResponse(None, headers={"x-fastapi-item-id": item_id})
|
||
|
|
|
||
|
|
|
||
|
|
@app.patch("/items/{item_id}")
|
||
|
|
def patch_item(item_id: str, item: Item):
|
||
|
|
return {"item_id": item_id, "item": item}
|
||
|
|
|
||
|
|
|
||
|
|
@app.trace("/items/{item_id}")
|
||
|
|
def trace_item(item_id: str):
|
||
|
|
return JSONResponse(None, media_type="message/http")
|
||
|
|
|
||
|
|
|
||
|
|
client = TestClient(app)
|
||
|
|
|
||
|
|
|
||
|
|
def test_get_api_route():
|
||
|
|
response = client.get("/items/foo")
|
||
|
|
assert response.status_code == 200, response.text
|
||
|
|
assert response.json() == {"item_id": "foo"}
|
||
|
|
|
||
|
|
|
||
|
|
def test_get_api_route_not_decorated():
|
||
|
|
response = client.get("/items-not-decorated/foo")
|
||
|
|
assert response.status_code == 200, response.text
|
||
|
|
assert response.json() == {"item_id": "foo"}
|
||
|
|
|
||
|
|
|
||
|
|
def test_delete():
|
||
|
|
response = client.request("DELETE", "/items/foo", json={"name": "Foo"})
|
||
|
|
assert response.status_code == 200, response.text
|
||
|
|
assert response.json() == {"item_id": "foo", "item": {"name": "Foo", "price": None}}
|
||
|
|
|
||
|
|
|
||
|
|
def test_head():
|
||
|
|
response = client.head("/items/foo")
|
||
|
|
assert response.status_code == 200, response.text
|
||
|
|
assert response.headers["x-fastapi-item-id"] == "foo"
|
||
|
|
|
||
|
|
|
||
|
|
def test_options():
|
||
|
|
response = client.options("/items/foo")
|
||
|
|
assert response.status_code == 200, response.text
|
||
|
|
assert response.headers["x-fastapi-item-id"] == "foo"
|
||
|
|
|
||
|
|
|
||
|
|
def test_patch():
|
||
|
|
response = client.patch("/items/foo", json={"name": "Foo"})
|
||
|
|
assert response.status_code == 200, response.text
|
||
|
|
assert response.json() == {"item_id": "foo", "item": {"name": "Foo", "price": None}}
|
||
|
|
|
||
|
|
|
||
|
|
def test_trace():
|
||
|
|
response = client.request("trace", "/items/foo")
|
||
|
|
assert response.status_code == 200, response.text
|
||
|
|
assert response.headers["content-type"] == "message/http"
|
||
|
|
|
||
|
|
|
||
|
|
def test_openapi_schema():
|
||
|
|
response = client.get("/openapi.json")
|
||
|
|
assert response.status_code == 200, response.text
|
||
|
|
assert response.json() == {
|
||
|
|
"openapi": "3.1.0",
|
||
|
|
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||
|
|
"paths": {
|
||
|
|
"/items/{item_id}": {
|
||
|
|
"get": {
|
||
|
|
"responses": {
|
||
|
|
"200": {
|
||
|
|
"description": "Successful Response",
|
||
|
|
"content": {"application/json": {"schema": {}}},
|
||
|
|
},
|
||
|
|
"422": {
|
||
|
|
"description": "Validation Error",
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"summary": "Get Items",
|
||
|
|
"operationId": "get_items_items__item_id__get",
|
||
|
|
"parameters": [
|
||
|
|
{
|
||
|
|
"required": True,
|
||
|
|
"schema": {"title": "Item Id", "type": "string"},
|
||
|
|
"name": "item_id",
|
||
|
|
"in": "path",
|
||
|
|
}
|
||
|
|
],
|
||
|
|
},
|
||
|
|
"delete": {
|
||
|
|
"responses": {
|
||
|
|
"200": {
|
||
|
|
"description": "Successful Response",
|
||
|
|
"content": {"application/json": {"schema": {}}},
|
||
|
|
},
|
||
|
|
"422": {
|
||
|
|
"description": "Validation Error",
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"summary": "Delete Item",
|
||
|
|
"operationId": "delete_item_items__item_id__delete",
|
||
|
|
"parameters": [
|
||
|
|
{
|
||
|
|
"required": True,
|
||
|
|
"schema": {"title": "Item Id", "type": "string"},
|
||
|
|
"name": "item_id",
|
||
|
|
"in": "path",
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"requestBody": {
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {"$ref": "#/components/schemas/Item"}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"required": True,
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"options": {
|
||
|
|
"responses": {
|
||
|
|
"200": {
|
||
|
|
"description": "Successful Response",
|
||
|
|
"content": {"application/json": {"schema": {}}},
|
||
|
|
},
|
||
|
|
"422": {
|
||
|
|
"description": "Validation Error",
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"summary": "Options Item",
|
||
|
|
"operationId": "options_item_items__item_id__options",
|
||
|
|
"parameters": [
|
||
|
|
{
|
||
|
|
"required": True,
|
||
|
|
"schema": {"title": "Item Id", "type": "string"},
|
||
|
|
"name": "item_id",
|
||
|
|
"in": "path",
|
||
|
|
}
|
||
|
|
],
|
||
|
|
},
|
||
|
|
"head": {
|
||
|
|
"responses": {
|
||
|
|
"200": {
|
||
|
|
"description": "Successful Response",
|
||
|
|
"content": {"application/json": {"schema": {}}},
|
||
|
|
},
|
||
|
|
"422": {
|
||
|
|
"description": "Validation Error",
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"summary": "Head Item",
|
||
|
|
"operationId": "head_item_items__item_id__head",
|
||
|
|
"parameters": [
|
||
|
|
{
|
||
|
|
"required": True,
|
||
|
|
"schema": {"title": "Item Id", "type": "string"},
|
||
|
|
"name": "item_id",
|
||
|
|
"in": "path",
|
||
|
|
}
|
||
|
|
],
|
||
|
|
},
|
||
|
|
"patch": {
|
||
|
|
"responses": {
|
||
|
|
"200": {
|
||
|
|
"description": "Successful Response",
|
||
|
|
"content": {"application/json": {"schema": {}}},
|
||
|
|
},
|
||
|
|
"422": {
|
||
|
|
"description": "Validation Error",
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"summary": "Patch Item",
|
||
|
|
"operationId": "patch_item_items__item_id__patch",
|
||
|
|
"parameters": [
|
||
|
|
{
|
||
|
|
"required": True,
|
||
|
|
"schema": {"title": "Item Id", "type": "string"},
|
||
|
|
"name": "item_id",
|
||
|
|
"in": "path",
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"requestBody": {
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {"$ref": "#/components/schemas/Item"}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"required": True,
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"trace": {
|
||
|
|
"responses": {
|
||
|
|
"200": {
|
||
|
|
"description": "Successful Response",
|
||
|
|
"content": {"application/json": {"schema": {}}},
|
||
|
|
},
|
||
|
|
"422": {
|
||
|
|
"description": "Validation Error",
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"summary": "Trace Item",
|
||
|
|
"operationId": "trace_item_items__item_id__trace",
|
||
|
|
"parameters": [
|
||
|
|
{
|
||
|
|
"required": True,
|
||
|
|
"schema": {"title": "Item Id", "type": "string"},
|
||
|
|
"name": "item_id",
|
||
|
|
"in": "path",
|
||
|
|
}
|
||
|
|
],
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"/items-not-decorated/{item_id}": {
|
||
|
|
"get": {
|
||
|
|
"responses": {
|
||
|
|
"200": {
|
||
|
|
"description": "Successful Response",
|
||
|
|
"content": {"application/json": {"schema": {}}},
|
||
|
|
},
|
||
|
|
"422": {
|
||
|
|
"description": "Validation Error",
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"summary": "Get Not Decorated",
|
||
|
|
"operationId": "get_not_decorated_items_not_decorated__item_id__get",
|
||
|
|
"parameters": [
|
||
|
|
{
|
||
|
|
"required": True,
|
||
|
|
"schema": {"title": "Item Id", "type": "string"},
|
||
|
|
"name": "item_id",
|
||
|
|
"in": "path",
|
||
|
|
}
|
||
|
|
],
|
||
|
|
}
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"components": {
|
||
|
|
"schemas": {
|
||
|
|
"Item": {
|
||
|
|
"title": "Item",
|
||
|
|
"required": ["name"],
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"name": {"title": "Name", "type": "string"},
|
||
|
|
"price": IsDict(
|
||
|
|
{
|
||
|
|
"title": "Price",
|
||
|
|
"anyOf": [{"type": "number"}, {"type": "null"}],
|
||
|
|
}
|
||
|
|
)
|
||
|
|
# TODO: remove when deprecating Pydantic v1
|
||
|
|
| IsDict({"title": "Price", "type": "number"}),
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"ValidationError": {
|
||
|
|
"title": "ValidationError",
|
||
|
|
"required": ["loc", "msg", "type"],
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"loc": {
|
||
|
|
"title": "Location",
|
||
|
|
"type": "array",
|
||
|
|
"items": {
|
||
|
|
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"msg": {"title": "Message", "type": "string"},
|
||
|
|
"type": {"title": "Error Type", "type": "string"},
|
||
|
|
},
|
||
|
|
},
|
||
|
|
"HTTPValidationError": {
|
||
|
|
"title": "HTTPValidationError",
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"detail": {
|
||
|
|
"title": "Detail",
|
||
|
|
"type": "array",
|
||
|
|
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||
|
|
}
|
||
|
|
},
|
||
|
|
},
|
||
|
|
}
|
||
|
|
},
|
||
|
|
}
|