The Scheduler
a42b1ff04e
Issue Manager / issue-manager (push) Has been cancelled
Build Docs / changes (push) Has been cancelled
Build Docs / langs (push) Has been cancelled
Build Docs / build-docs (push) Has been cancelled
Build Docs / docs-all-green (push) Has been cancelled
Conflict detector / main (push) Has been cancelled
Test Redistribute / test-redistribute (fastapi) (push) Has been cancelled
Test Redistribute / test-redistribute (fastapi-slim) (push) Has been cancelled
Test Redistribute / test-redistribute-alls-green (push) Has been cancelled
Test / lint (push) Has been cancelled
Test / test (pydantic-v1, 3.10) (push) Has been cancelled
Test / test (pydantic-v1, 3.11) (push) Has been cancelled
Test / test (pydantic-v1, 3.13) (push) Has been cancelled
Test / test (pydantic-v1, 3.8) (push) Has been cancelled
Test / test (pydantic-v1, 3.9) (push) Has been cancelled
Test / test (pydantic-v2, 3.10) (push) Has been cancelled
Test / test (pydantic-v2, 3.11) (push) Has been cancelled
Test / test (pydantic-v2, 3.12) (push) Has been cancelled
Test / test (pydantic-v2, 3.13) (push) Has been cancelled
Test / test (pydantic-v2, 3.14) (push) Has been cancelled
Test / test (pydantic-v2, 3.8) (push) Has been cancelled
Test / test (pydantic-v2, 3.9) (push) Has been cancelled
Test / coverage-combine (push) Has been cancelled
Test / check (push) Has been cancelled
Label Approved / label-approved (push) Has been cancelled
FastAPI People Contributors / job (push) Has been cancelled
FastAPI People Sponsors / job (push) Has been cancelled
Update Topic Repos / topic-repos (push) Has been cancelled
FastAPI People / job (push) Has been cancelled
Test / test (pydantic-v1, 3.12) (push) Has been cancelled
100 lines
2.9 KiB
Python
100 lines
2.9 KiB
Python
import typing
|
|
|
|
from fastapi import FastAPI
|
|
from fastapi.responses import JSONResponse
|
|
from fastapi.testclient import TestClient
|
|
from pydantic import BaseModel
|
|
|
|
app = FastAPI()
|
|
|
|
|
|
class JsonApiResponse(JSONResponse):
|
|
media_type = "application/vnd.api+json"
|
|
|
|
|
|
class Error(BaseModel):
|
|
status: str
|
|
title: str
|
|
|
|
|
|
class JsonApiError(BaseModel):
|
|
errors: typing.List[Error]
|
|
|
|
|
|
@app.get(
|
|
"/a/{id}",
|
|
response_class=JsonApiResponse,
|
|
responses={422: {"description": "Error", "model": JsonApiError}},
|
|
)
|
|
async def a(id):
|
|
pass # pragma: no cover
|
|
|
|
|
|
client = TestClient(app)
|
|
|
|
|
|
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": {
|
|
"/a/{id}": {
|
|
"get": {
|
|
"responses": {
|
|
"422": {
|
|
"description": "Error",
|
|
"content": {
|
|
"application/vnd.api+json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/JsonApiError"
|
|
}
|
|
}
|
|
},
|
|
},
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {"application/vnd.api+json": {"schema": {}}},
|
|
},
|
|
},
|
|
"summary": "A",
|
|
"operationId": "a_a__id__get",
|
|
"parameters": [
|
|
{
|
|
"required": True,
|
|
"schema": {"title": "Id"},
|
|
"name": "id",
|
|
"in": "path",
|
|
}
|
|
],
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"Error": {
|
|
"title": "Error",
|
|
"required": ["status", "title"],
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {"title": "Status", "type": "string"},
|
|
"title": {"title": "Title", "type": "string"},
|
|
},
|
|
},
|
|
"JsonApiError": {
|
|
"title": "JsonApiError",
|
|
"required": ["errors"],
|
|
"type": "object",
|
|
"properties": {
|
|
"errors": {
|
|
"title": "Errors",
|
|
"type": "array",
|
|
"items": {"$ref": "#/components/schemas/Error"},
|
|
}
|
|
},
|
|
},
|
|
}
|
|
},
|
|
}
|