الموجهات وOpenAPI وتطور العقد

from fastapi import APIRouter, FastAPI
from fastapi.testclient import TestClient
router = APIRouter(prefix="/v1/items", tags=["items"])
@router.get("/{item_id}", operation_id="read_item_v1")
def read_item(item_id: int): return {"id": item_id}
app = FastAPI()
app.include_router(router)
with TestClient(app) as client:
    print(client.get("/v1/items/4").json())
print(app.openapi()["paths"]["/v1/items/{item_id}"]["get"]["operationId"])

{'id': 4}
read_item_v1

تنتج البادئة المسار والمعرف المختار، وتغير الوسوم التنظيم لا الصلاحية.

from fastapi import FastAPI
from pydantic import BaseModel
class PublicItem(BaseModel):
    id: int
    name: str
app = FastAPI()
@app.get("/item", response_model=PublicItem)
def item(): return {"id": 1, "name": "pen"}
schema = app.openapi()
reference = schema["paths"]["/item"]["get"]["responses"]["200"]["content"]["application/json"]["schema"]["$ref"]
print(reference.endswith("/PublicItem"))
print(schema["components"]["schemas"]["PublicItem"]["required"])

True
['id', 'name']

يشير الرد للنموذج ويتطلب الحقلين دون طلب، ولا يثبت المخطط معنى العمل.