Understøttede typer og JSON-skemaer
På denne side
Bygestenene i dine skemaer
For at definere strukturen af dine svar har du syv JSON-typer til rådighed. Hver type tjener et specifikt behov, når du modellerer dine data. Det er afgørende at forstå disse typer for at kunne designe effektive skemaer.
De syv understøttede typer
string
Den mest almindelige type. Bruges til navne, beskrivelser, identifikatorer og alt tekstindhold.
{
"type": "object",
"properties": {
"name": { "type": "string" },
"description": { "type": "string" }
}
}
number
Dækker både heltal og decimaltal. Der skelnes ikke mellem integer og float – en enkelt number-type håndterer begge dele.
{
"properties": {
"price": { "type": "number" },
"quantity": { "type": "number" }
}
}
boolean
Sandt eller falsk. Perfekt til flag, valideringer og binære beslutninger.
{
"properties": {
"in_stock": { "type": "boolean" },
"express_delivery": { "type": "boolean" }
}
}
object
Giver dig mulighed for at næste strukturer. Et objekt kan indeholde andre objekter, arrays eller skalare værdier – uden begrænsning på dybden.
{
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"street": { "type": "string" },
"city": { "type": "string" },
"postal_code": { "type": "string" }
}
}
}
}
array
Lister over elementer af samme type. Du kan have arrays af strings, tal, objekter eller endda arrays.
{
"properties": {
"skills": {
"type": "array",
"items": { "type": "string" }
}
}
}
enum
En endelig mængde af tilladte værdier. Essentiel til kategorisering og klassificering.
{
"properties": {
"priority": {
"type": "string",
"enum": ["low", "medium", "high", "critical"]
}
}
}
anyOf
Lader dig definere type-unions. Et felt kan acceptere flere forskellige strukturer. Nyttigt, når et enkelt felt kan antage varierede former.
{
"properties": {
"contact": {
"anyOf": [
{
"type": "object",
"properties": {
"email": { "type": "string" }
}
},
{
"type": "object",
"properties": {
"phone": { "type": "string" }
}
}
]
}
}
}
Kombination af typer
Styrken ved skemaer kommer af at kombinere disse typer. Her er et realistisk skema til analyse af et produkt:
{
"type": "object",
"properties": {
"name": { "type": "string" },
"price": { "type": "number" },
"in_stock": { "type": "boolean" },
"category": {
"type": "string",
"enum": ["electronics", "clothing", "grocery", "other"]
},
"tags": {
"type": "array",
"items": { "type": "string" }
},
"manufacturer": {
"type": "object",
"properties": {
"name": { "type": "string" },
"country": { "type": "string" }
}
}
}
}
Dette skema blander skalare værdier, en enum, et array og et næstet objekt. Modellen vil overholde alle begrænsninger ved hvert eneste kald.
Valgfrie felter
For at gøre et felt valgfrit skal du bruge anyOf sammen med null:
{
"properties": {
"phone": {
"anyOf": [
{ "type": "string" },
{ "type": "null" }
]
}
}
}
I Pydantic svarer dette til phone: str | None.
Vigtige pointer
- Syv tilgængelige typer:
string,number,object,array,boolean,enum,anyOf - Typer kan kombineres frit for at modellere komplekse strukturer
- Valgfrie felter bruger
anyOfsammen mednull - Ingen skelnen mellem heltal og decimaltal – en enkelt
number-type dækker begge enumgennemtvinger prædefinerede værdier til klassificeringer