Laat een model de body controleren

In hoofdstuk 5 bewaakten twee functies elke schrijfactie die je server accepteerde, en ze staan nog in reading_server.py. body_error keek naar het verzoek, en book_error naar de geparste gegevens:

handle riep ze in die volgorde aan, en create_book en replace_book draaiden alleen als beide None teruggaven. De app doet beide taken met het model dat je in les 1 las, BookIn, en één annotatie in elke def-regel: book: BookIn.

Het model controleert eerst

Als POST /books binnenkomt, leest FastAPI de body, parset die als JSON en controleert het resultaat tegen BookIn, allemaal voordat create_book draait. Je functie wordt alleen aangeroepen met een body die door de controle kwam, en ze ontvangt die body als een BookIn-object. Het object geeft zijn gecontroleerde waarden als attributen, geschreven met een punt: book.title en book.author. Het is geen dict, dus book["title"] werpt TypeError op.

Op de versies die deze cursus gebruikt, weigert het model:

• een body die geen JSON-object is, of waarin title of author ontbreekt;

• een veld dat geen string is: 7 en true worden geweigerd, en nooit omgezet in "7" of "true";

• een veld zonder enig teken behalve spaties, zoals "" of " ". Daar vraagt pattern=r"\S" om: één teken, waar dan ook, dat geen spatie, tab, regeleinde of ander soort witruimte is.

De rest accepteert het zoals het is. " Ærø " houdt zijn spaties, "7" is een string, en een titel van 3000 tekens heeft geen limiet om te overschrijden. Velden die het model niet noemt, zoals "id": 99, worden weggelaten voordat je functie de body ziet, dus een client kan het id van een boek niet kiezen.

De 422 van FastAPI lezen

Op die body antwoordde je server uit hoofdstuk 5 {"error": "author is missing"}. De app antwoordt 422 met deze body:

{"detail":[{"type":"missing","loc":["body","author"],"msg":"Field required","input":{"title":"Dune"}}]}

detail is een lijst, met één item per probleem. In elk item noemt type de regel die niet werd gehaald (hier missing; string_type voor een getal waar een string hoort; string_pattern_mismatch voor een lege titel), zegt loc waar (["body", "author"], het veld author van de body), zegt msg het in woorden, en herhaalt input de waarde die werd gecontroleerd. Jouw fout was één zin voor een mens. Deze is data waar een clientprogramma op kan reageren, veld voor veld. Beide hebben 422.

Waar het framework anders beslist

De meeste slechte body’s krijgen de status die ze van je server kregen. Deze niet:

FastAPI parset een body alleen als JSON wanneer de content-type JSON zegt: application/json, of een application/-type waarvan het subtype op +json eindigt, zoals application/merge-patch+json. Elk ander label, of geen label, laat de body als tekst staan, en het model weigert tekst omdat het geen object is; de 422 zegt dat het model een object verwachtte. Er is geen aparte 415. Kapotte JSON is ook een 422, met het type json_invalid. Bytes die niet als UTF-8 te decoderen zijn, zijn het enige bodyprobleem waarop FastAPI met 400 antwoordt, en de detail is daar een gewone string.

De rij met PUT gaat over volgorde. Je server zocht het id op voordat hij de body las, dus een onbekend id was een 404, wat de body ook bevatte. FastAPI controleert de body voordat het replace_book aanroept, dus een slechte body is een 422 voordat je functie iets kan opzoeken. Vanaf hoofdstuk 7 vroeg je server ook vóór beide om een token; deze app heeft geen tokens.

Twee statussen uit hoofdstuk 5 komen hier nooit voor. 411 en 413 waren framingwerk in je read_body; TestClient stuurt altijd een lengte, en de app stelt geen limiet aan de grootte.

201 en location

De regel boven create_book is @app.post("/books", status_code=201): elke waarde die de functie teruggeeft, gaat de deur uit met status 201. De def-regel vraagt ook om response: Response. FastAPI geeft een responseobject mee, en elke header die je erop zet, wordt naar het antwoord gekopieerd:

response.headers["location"] = f"/books/{book_id}"

Geef het opgeslagen boek terug, en FastAPI stuurt het als JSON-body van de 201, met jouw location. replace_book heeft geen van beide nodig: een vervangen boek is een gewone 200.

Je opdracht

Schrijf de body’s van create_book en replace_book in reading_app.py:

1. create_book(book, response) neemt het id uit STATE["next_id"] en telt één op bij STATE["next_id"], slaat {"id": ..., "title": book.title, "author": book.author} onder dat id op in STATE["books"], zet location op /books/ plus het id, en geeft het opgeslagen boek terug.

2. replace_book(book_id, book) werpt HTTPException(status_code=404, detail="no such book") op voor een id dat STATE["books"] niet bevat. Anders slaat het het boek op onder book_id, het id uit de URL, en geeft het terug.

Schrijf geen eigen controles op title of author: het model heeft dat al gedaan, en een regel van jou die iets weigert wat het model accepteert, zoals een titel met spaties eromheen, zou de app laten verschillen van zijn eigen model. Om één verzoek te proberen in het tabblad Shell, met de importwaarschuwing van de testclient uitgezet:

python -W ignore -c "from fastapi.testclient import TestClient; import reading_app; r = TestClient(reading_app.app).post('/books', json={'title': 'Piranesi', 'author': 'Susanna Clarke'}); print(r.status_code, r.headers['location'], r.json())"

Het drukt 201 /books/3 {'id': 3, 'title': 'Piranesi', 'author': 'Susanna Clarke'} af. Druk daarna op Check my work. Tot nu toe is geen enkele byte van de antwoorden van je app over een socket gegaan; les 4 draait hem onder een echte server voor drie verzoeken.