[PYTHON] Zur Zeit möchte ich mit FastAPI zeigen, wie man eine solche API in swagger verwendet

Überblick

Definieren Sie vorerst die Form der Antwort von der API auf dem Prahlerbildschirm der Fast API. Artikel für diejenigen, die Beispielantworten sehen möchten.

Ich war so, aber ich konnte keinen solchen Artikel oder Blog finden, Vorerst habe ich das offizielle Tutorial von Fastapi durchgesehen. Ich schrieb es in der Hoffnung, dass es jemandem mit dem gleichen Zweck helfen würde.

Annahme

―― Angenommen, dieser Datentyp wird als Antwort zurückgegeben.

{
    "Special_choco1": {
      "Milk": "many",
      "Quantity": 5,
      "Cacao": "a little"
    },
    "Store":[
      {
        "Tokyo": "sibuya",
        "Hokkaido": "sapporo",
        "Osaka": "nanba"
      }
    ]
}

• Die FastAPI-Version ist 0.52.0

--Schreibe in main.py. Schreiben Sie in eine Datei, die app = FastAPI () schreibt.

-Ich bin sicher, es gibt einen anderen besseren Weg, es zu schreiben.

Definieren Sie zunächst die Form der Antwort

from fastapi import FastAPI
from pydantic import BaseModel
from typing import List

class choco_model(BaseModel):
    Milk: str
    Quantity: int
    Cacao: str

class Store_model(BaseModel):
    Tokyo: str
    Hokkaido: str
    Osaka: str

class Special_choco(BaseModel):
    Special_choco1: choco_model
    Store: List[Store_model]

app = FastAPI()

@app.get("/api/v1/chocolate/{name}")
async def making_choco(name: str):
    return #Ausgelassen. Ein Bild des Schreibens von etwas, das den in der Prämisse beschriebenen JSON zu ändern scheint.

Zeigen Sie das im Beispielwert definierte Modell an

Geben Sie das Modell, das Sie in response_model definieren möchten, im Dekorator an. Dann wird es im Beispielwert von swagger angezeigt.

#Unterlassung)

app = FastAPI()

@app.get("/api/v1/chocolate/{name}", response_model=Special_choco)
async def making_choco(name: str):
    return #Ausgelassen. Ein Bild des Schreibens von etwas, das den in der Prämisse beschriebenen JSON zu ändern scheint.

So was.

Beispielwert genauer anzeigen.

Anzeige nicht nur des Typs und der Datenstruktur, sondern auch der zurückgegebenen Wert Beschreiben Sie die Daten, die Sie im Definitionsteil in der Klasse Config anzeigen möchten, wie folgt. Anschließend wird der konkrete Wert in der Beispielwertspalte angezeigt.

from fastapi import FastAPI
from pydantic import BaseModel
from typing import List


class choco_model(BaseModel):
    Milk: str
    Quantity: int
    Cacao: str
    class Config:
        schema_extra = {
            "example": {
                "Milk": "very lot",
                "Quantity": 10,
                "Cacao": "many",
            }
        }

class Store_model(BaseModel):
    Tokyo: str
    Hokkaido: str
    Osaka: str

    class Config:
        schema_extra = {
            "example": {
                "Tokyo": "shibuya",
                "Hokkaido": "sapporo",
                "Osaka": "nishinari",
            }
        }
#Unterlassung

Es wird wie folgt angezeigt.

Schließlich

fastapi offizielles Tutorial hat viel Volumen, aber es ist gut, es zu tun.