Vai al contenuto
code-to-code

Apro l'indice…

↑ ↓ per scegliere, Invio per aprire, Esc per chiudere

HTTP e API4. Il primo serverp. 99

Il primo server, la palestra

Quattro piccole API da completare, con i test

  • 45–60 minuti di lavoro

Quattro esercizi, dal ★ al ★★★, tutti nell'officina del deposito. Ognuno è una piccola API di Ivo Brambati, il manutentore, con il suo file di test: quando è tutto verde, hai finito.

Gli esercizi da scaricare

Una cartella con i file da completare e i test già pronti. Come si usa: la guida in cinque passi.

http-primo-server.zip10 KB

Prima di iniziare

Scompatta lo zip e segui il README.md che c'è dentro: venv, pip install -r requirements.txt (FastAPI è grande, ci vuole qualche minuto), code .. Se è la prima volta, la pagina Come si usa un esercizio lo fa con te, un comando alla volta.

Ogni esercizio, sempre gli stessi passi:

  1. Apri il file in palestra/. In alto: la storia, cosa fai, come provi, dal vivo.
  2. Sopra ogni rotta da fare c'è un commento con la richiesta e la risposta che vuole il test. Al posto della riga del 501 scrivi il tuo codice.
  3. pytest palestra/test_<nome>.py -v, oppure la provetta di VS Code. Per i test il server non serve.
  4. Vuoi vederla dal vivo? In un secondo terminale fastapi dev palestra/<nome>.py, poi http://127.0.0.1:8000/docs. Spegni con Ctrl+C prima di accendere l'esercizio dopo: la porta 8000 è una sola.
  5. Rosso? Leggi l'ultima riga del messaggio. Bloccato da 15 minuti? Apri il primo aiutino, non la soluzione.
#EsercizioLa cosa nuovaDifficoltà
1La lavagna dell'officinaun dizionario che diventa JSON★
2Cosa c'è da riparareuna lista, presa dai dati del file★
3Il turno di oggicostruire la risposta: null, true, la tupla★★
4L'armadio degli attrezziil decoratore e il def, scritti da te★★★

1 · La lavagna dell'officina ★

palestra/lavagna.py

Ivo vuole che chi apre l'indirizzo principale della lavagna trovi un saluto. La rotta dell'orario è già fatta: è il tuo esempio.

GET /        ->  200 e {"officina": "Deposito della Linea Menta", "messaggio": "Benvenuto in officina"}
GET /orario  ->  200 e {"apre": "6:00", "chiude": "22:00"}                  (già fatta)

Come provi: pytest palestra/test_lavagna.py -v

Dal vivo: fastapi dev palestra/lavagna.py, poi curl -s http://127.0.0.1:8000/ oppure /docs.

Aiutino 1
Guarda la rotta /orario, appena sopra la tua: è fatta allo stesso modo, con un altro dizionario.
Aiutino 2
Basta una riga: return e il dizionario del commento. Le chiavi e i testi vanno scritti lettera per lettera: il test li confronta tutti. E la riga del 501 va cancellata, non lasciata sopra.

2 · Cosa c'è da riparare ★

palestra/riparazioni.py

Sulla lavagna c'è l'elenco dei treni da riparare. Nel file è già scritto, in cima, come una lista di dizionari: da_riparare. Ivo vuole due rotte: tutto l'elenco, e la prossima riparazione da fare, cioè la prima.

GET /riparazioni           ->  200 e [{"treno": "T09", "guasto": "porte bloccate"}, {"treno": "M16", …}, {"treno": "M14", …}]
GET /riparazioni/prossima  ->  200 e {"treno": "T09", "guasto": "porte bloccate"}
GET /riparazioni/quante    ->  200 e {"quante": 3}                          (già fatta)

Due test cambiano la lista per un momento, con un attrezzo di pytest che si chiama monkeypatch: controllano che le rotte leggano davvero da_riparare, e non una copia scritta a mano.

Come provi: pytest palestra/test_riparazioni.py -v

Aiutino 1
La lista c'è già, in cima al file. La rotta la deve solo restituire: niente for, niente copie.
Aiutino 2
Una lista Python diventa una lista JSON: return e la lista, senza metterla dentro un dizionario. E la prima di una lista sta in posizione 0, non 1.

3 · Il turno di oggi ★★

palestra/turno.py

Ivo scrive sulla lavagna chi è di turno, chi lo aiuta e l'orario: nel file è il dizionario oggi. Oggi è da solo, e l'aiutante è None. Il server deve dare il riassunto del turno, costruito da oggi.

GET /turno          ->  200 e {"di_turno": "Ivo Brambati", "aiutante": null, "da_solo": true, "orario": [6, 14]}
GET /turno/lavagna  ->  200 e {"manutentore": "Ivo Brambati", "aiutante": null, "dalle": 6, "alle": 14}   (già fatta)
Chiave della rispostaDa dove viene
di_turnoil manutentore di oggi
aiutantel'aiutante di oggi, così com'è
da_solovero se l'aiutante è None, altrimenti falso
orariola tupla con l'ora d'inizio e quella di fine

L'ultimo test mette al posto di oggi il turno del pomeriggio (Dario Sala, con Ivo come aiutante): la risposta deve cambiare con lui.

Come provi: pytest palestra/test_turno.py -v

Aiutino 1
Il commento sopra la rotta è JSON: null, true. Tu scrivi Python: None, True. Al JSON pensa FastAPI.
Aiutino 2
Ogni valore viene da oggi: oggi["manutentore"], oggi["aiutante"], e così via. Niente nomi o numeri scritti a mano.
Aiutino 3
da_solo è una domanda con risposta vero o falso: oggi["aiutante"] is None vale già True o False, non serve un if. L'orario: (oggi["dalle"], oggi["alle"]).

4 · L'armadio degli attrezzi ★★★

palestra/attrezzi.py

Nell'armadio dell'officina certi attrezzi sono finiti. L'armadio è un dizionario, attrezzo → pezzi. Prima di ordinare, Ivo vuole chiedere al server quali mancano e quanti pezzi ci sono in tutto. Questa volta le rotte non ci sono: scrivi tu anche il decoratore e la riga del def. Per la prima il commento te li dà; per la seconda, no.

GET /attrezzi            ->  200 e {"chiave inglese": 3, "trapano": 1, "saldatrice": 0, "multimetro": 2, "cric": 0}   (già fatta)
GET /attrezzi/mancanti   ->  200 e ["saldatrice", "cric"]
GET /attrezzi/conteggio  ->  200 e {"attrezzi": 5, "pezzi": 6}
POST /attrezzi/mancanti  ->  405: la rotta c'è, ma solo per GET
GET /attrezzi/martello   ->  404: questa rotta non c'è

L'ultimo test è verde già all'inizio: il 404 di un percorso che non c'è lo dà FastAPI da solo, senza una riga tua.

Come provi: pytest palestra/test_attrezzi.py -v

Aiutino 1
Copia la forma della rotta /attrezzi, che è già fatta: un decoratore con il percorso nuovo, un def con un nome nuovo, il return. Il percorso comincia con la barra.
Aiutino 2
Gli attrezzi che mancano sono un setaccio, come in I dizionari: lista vuota, for attrezzo, pezzi in armadio.items():, if, append. Il return va dopo il for, non dentro.
Aiutino 3
Il conteggio: quanti attrezzi diversi è quante chiavi ha l'armadio (len); i pezzi in tutto sono la somma dei valori, sum(armadio.values()).

Prova tu, senza test

Una cosa che i test non possono controllare: guardare le tue API con i tuoi occhi. Per ogni esercizio finito, accendi il server (fastapi dev palestra/<nome>.py), apri http://127.0.0.1:8000/docs e prova ogni rotta con Try it out ed Execute. Poi, nella barra del browser, un percorso che non c'è. Prima di passare al prossimo, Ctrl+C.


Finito? Confronta le tue con le soluzioni: per ogni esercizio ci sono il ragionamento, il codice e le trappole più comuni.