Támogatott típusok és JSON-sémák
Ezen az oldalon
A sémáid építőkövei
A válaszaid szerkezetének meghatározásához hét JSON-típus áll rendelkezésedre. Mindegyik típus az adatmodellezés egy specifikus igényét szolgálja. Ezen típusok megértése elengedhetetlen a hatékony sémák tervezéséhez.
A hét támogatott típus
string
A leggyakoribb típus. Nevek, leírások, azonosítók és bármilyen szöveges tartalom esetén használatos.
{
"type": "object",
"properties": {
"name": { "type": "string" },
"description": { "type": "string" }
}
}
number
Le fedezi az egész számokat és a lebegőpontos számokat. Nincs különbség az integer és a float között – egyetlen number típus kezeli mindkettőt.
{
"properties": {
"price": { "type": "number" },
"quantity": { "type": "number" }
}
}
boolean
Igaz vagy hamis. Tökéletesen alkalmas zászlókhoz, validációkhoz és bináris döntésekhez.
{
"properties": {
"in_stock": { "type": "boolean" },
"express_delivery": { "type": "boolean" }
}
}
object
Lehetővé teszi a strukturált adatok beágyazását. Egy objektum tartalmazhat más objektumokat, tömböket vagy skaláris értékeket – mélységi korlátozás nélkül.
{
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"street": { "type": "string" },
"city": { "type": "string" },
"postal_code": { "type": "string" }
}
}
}
}
array
Azonos típusú elemek listája. Lehetséges stringekből, számokból, objektumokból, vagy akár tömbökből álló tömböt létrehozni.
{
"properties": {
"skills": {
"type": "array",
"items": { "type": "string" }
}
}
}
enum
Megengedett értékek véges halmaza. Elengedhetetlen kategorizáláshoz és osztályozáshoz.
{
"properties": {
"priority": {
"type": "string",
"enum": ["low", "medium", "high", "critical"]
}
}
}
anyOf
Lehetővé teszi típusuniók definiálását. Egy mező több különböző struktúrát is elfogadhat. Hasznos akkor, ha egyetlen mező változatos formákat ölthet.
{
"properties": {
"contact": {
"anyOf": [
{
"type": "object",
"properties": {
"email": { "type": "string" }
}
},
{
"type": "object",
"properties": {
"phone": { "type": "string" }
}
}
]
}
}
}
Típusok kombinálása
A sémák ereje ezen típusok kombinálásában rejlik. Íme egy realisztikus séma egy termék elemzéséhez:
{
"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" }
}
}
}
}
Ez a séma skaláris típusokat, egy enumot, egy tömböt és egy beágyazott objektumot vegyít. A modell minden hívásnál betartja az összes kényszert.
Opcionális mezők
Egy mező opcionálissá tételéhez használd az anyOf kulcsszót a null értékkel:
{
"properties": {
"phone": {
"anyOf": [
{ "type": "string" },
{ "type": "null" }
]
}
}
}
Pydanticben ez a phone: str | None kifejezésnek felel meg.
Főbb megállapítások
- Hét elérhető típus:
string,number,object,array,boolean,enum,anyOf - A típusok szabadon kombinálhatók komplex struktúrák modellezéséhez
- Az opcionális mezők az
anyOfés anullhasználatával készülnek - Nincs különbség egész és lebegőpontos szám között – egyetlen
numbertípus létezik - Az
enumelőre definiált értékeket kényszerít ki az osztályozásokhoz