Hvordan genererer FastAPI automatisk dokumentation?

Question

Accepted Answer

FastAPI **genererer automatisk interaktiv API-dokumentation** fra din kode — dine ruter, parametre og Pydantic-modeller bliver omdannet til et OpenAPI-skema, som driver to gennemsynlige dokumentations-UI'er (Swagger UI og ReDoc) uden ekstra indsats.

## Du får dokumentation gratis

```python
class Item(BaseModel):
    name: str
    price: float = Field(gt=0, description="Price in USD")

@app.post("/items", tags=["items"], summary="Create an item")
def create_item(item: Item):
    """Create a new item with a name and price."""   # docstring → endpoint description
    return item
```

Blot ved at skrive typede endpoints og modeller producerer FastAPI fuldstændig dokumentation — ingen separate dokumentationsfiler at skrive eller vedligeholde.

## De to indbyggede dokumentations-UI'er

```text
/docs   → Swagger UI — interactive: browse endpoints AND test them in the browser
          (fill in parameters, send requests, see responses live)
/redoc  → ReDoc — a clean, readable reference-style view
/openapi.json → the raw OpenAPI schema (usable to generate client SDKs, etc.)
```

Besøg `/docs` og du kan udforske hvert endpoint, se påkrevne parametre og responsforms, og **send rigtige anmodninger** direkte fra browseren — uvurderligt under udvikling og for API-forbrugere.

## Hvor dokumentationsindholdet kommer fra

```text
Route decorators → paths, HTTP methods, tags, summaries
Type hints       → parameter types, required/optional
Pydantic models  → request/response schemas, field constraints & descriptions
Docstrings       → endpoint descriptions
Field(..., description=, example=) → field-level docs and examples
```

Alt er afledt af den kode, du allerede skriver — dokumentationen forbliver automatisk **synkroniseret** med implementeringen.

## Berigelse af dokumentationen

```python
app = FastAPI(title="My API", version="1.0", description="...")
@app.get("/x", response_model=Item, responses={404: {"description": "Not found"}})
```

## Hvorfor det betyder noget

Automatisk interaktiv dokumentation er en af FastAPI's mest berømmede funktioner og en vigtig grund til dens popularitet.

Fordi dokumentationen genereres direkte fra din kode (ruter, typehenvisninger, Pydantic-modeller, docstrings), er den altid **synkroniseret** med den faktiske implementering — hvilket eliminerer det kroniske problem med, at dokumentation bliver forældet, som plager håndskrevet dokumentation.

Den interaktive Swagger UI (`/docs`) lader udviklere og API-forbrugere **udforske og teste endpoints live i browseren**, hvilket dramatisk forbedrer udvikleroplevelsen og reducerer integrationsfriktion.

Det genererede OpenAPI-skema kan også drive generering af klient-SDK og kontrakttest.

At få professionel, præcis, interaktiv API-dokumentation i det væsentlige gratis — bare ved at skrive veltypiseret kode — er en betydelig produktivitets- og kvalitetsvinding, hvilket gør dette til en vigtig, karakteristisk FastAPI-kapacitet.