Podprti tipi in sheme JSON
Na tej strani
Gradniki tvojih shem
Za opredelitev strukture svojih odgovorov imaš na voljo sedem tipov JSON. Vsak služi specifični potrebi pri modeliranju tvojih podatkov. Razumevanje teh tipov je ključno za oblikovanje učinkovitih shem.
Sedem podprtih tipov
string
Najpogostejši tip. Uporablja se za imena, opise, identifikatorje in katero koli besedilno vsebino.
{
"type": "object",
"properties": {
"name": { "type": "string" },
"description": { "type": "string" }
}
}
number
Pokriva cela števila in števila s plavajočo vejico. Ni razlike med integer in float – en sam tip number obravnava oboje.
{
"properties": {
"price": { "type": "number" },
"quantity": { "type": "number" }
}
}
boolean
True ali false. Idealno za zastavice, validacije in binarne odločitve.
{
"properties": {
"in_stock": { "type": "boolean" },
"express_delivery": { "type": "boolean" }
}
}
object
Omogoča gnezdenje struktur. Objekt lahko vsebuje druge objekte, polja ali skalarje – brez omejitve globine.
{
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"street": { "type": "string" },
"city": { "type": "string" },
"postal_code": { "type": "string" }
}
}
}
}
array
Seznami elementov istega tipa. Lahko imaš polja nizov, števil, objektov ali celo polj.
{
"properties": {
"skills": {
"type": "array",
"items": { "type": "string" }
}
}
}
enum
Končna množica dovoljenih vrednosti. Bistveno za kategorizacije in razvrščanje.
{
"properties": {
"priority": {
"type": "string",
"enum": ["low", "medium", "high", "critical"]
}
}
}
anyOf
Omogoča definiranje unij tipov. Polje lahko sprejme več različnih struktur. Uporabno, ko lahko eno polje zavzame različne oblike.
{
"properties": {
"contact": {
"anyOf": [
{
"type": "object",
"properties": {
"email": { "type": "string" }
}
},
{
"type": "object",
"properties": {
"phone": { "type": "string" }
}
}
]
}
}
}
Kombiniranje tipov
Moč shem izvira iz kombiniranja teh tipov. Tukaj je realistična shema za analizo izdelka:
{
"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" }
}
}
}
}
Ta shema meša skalarje, enum, polje in gnezden objekt. Model bo spoštoval vsako omejitev pri vsakem klicu.
Izbirna polja
Če želiš polje narediti izbirno, uporabi anyOf z null:
{
"properties": {
"phone": {
"anyOf": [
{ "type": "string" },
{ "type": "null" }
]
}
}
}
V Pydanticu to ustreza phone: str | None.
Ključne ugotovitve
- Sedem razpoložljivih tipov:
string,number,object,array,boolean,enum,anyOf - Tipi se prosto kombinirajo za modeliranje kompleksnih struktur
- Izbirna polja uporabljajo
anyOfznull - Ni razlike med celimi števili in števili s plavajočo vejico – en sam tip
number enumvsili vnaprej določene vrednosti za razvrščanje