Podporované typy a schémata JSON
Na této stránce
Stavební kameny tvých schémat
Pro definici struktury svých odpovědí máš k dispozici sedm typů JSON. Každý z nich slouží ke specifickému účelu při modelování dat. Pochopení těchto typů je zásadní pro navrhování efektivních schémat.
Sedm podporovaných typů
string
Nejběžnější typ. Používá se pro jména, popisy, identifikátory a jakýkoli textový obsah.
{
"type": "object",
"properties": {
"name": { "type": "string" },
"description": { "type": "string" }
}
}
number
Zahrnuje celá čísla i desetinná čísla. Neexistuje rozdíl mezi integer a float – jeden typ number zvládne obojí.
{
"properties": {
"price": { "type": "number" },
"quantity": { "type": "number" }
}
}
boolean
Pravda nebo nepravda. Ideální pro příznaky, validace a binární rozhodnutí.
{
"properties": {
"in_stock": { "type": "boolean" },
"express_delivery": { "type": "boolean" }
}
}
object
Umožňuje vnořovat struktury. Objekt může obsahovat jiné objekty, pole nebo skalární hodnoty – bez omezení hloubky.
{
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"street": { "type": "string" },
"city": { "type": "string" },
"postal_code": { "type": "string" }
}
}
}
}
array
Seznamy prvků stejného typu. Můžeš mít pole řetězců, čísel, objektů nebo dokonce polí.
{
"properties": {
"skills": {
"type": "array",
"items": { "type": "string" }
}
}
}
enum
Konečná množina povolených hodnot. Nezbytné pro kategorizace a klasifikace.
{
"properties": {
"priority": {
"type": "string",
"enum": ["low", "medium", "high", "critical"]
}
}
}
anyOf
Umožňuje definovat sjednocení typů. Pole může přijímat několik různých struktur. Užitečné, když může jedno pole nabývat různých forem.
{
"properties": {
"contact": {
"anyOf": [
{
"type": "object",
"properties": {
"email": { "type": "string" }
}
},
{
"type": "object",
"properties": {
"phone": { "type": "string" }
}
}
]
}
}
}
Kombinování typů
Síla schémat spočívá v kombinování těchto typů. Zde je realistické schéma pro analýzu produktu:
{
"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" }
}
}
}
}
Toto schéma mísí skalární typy, enum, pole a vnořený objekt. Model bude respektovat každé omezení při každém volání.
Volitelná pole
Aby bylo pole volitelné, použij anyOf s hodnotou null:
{
"properties": {
"phone": {
"anyOf": [
{ "type": "string" },
{ "type": "null" }
]
}
}
}
V Pydanticu to odpovídá zápisu phone: str | None.
Klíčové poznatky
- Sedm dostupných typů:
string,number,object,array,boolean,enum,anyOf - Typy lze libovolně kombinovat pro modelování složitých struktur
- Volitelná pole využívají
anyOfs hodnotounull - Žádný rozdíl mezi celými a desetinnými čísly – existuje pouze jeden typ
number enumvynucuje předem definované hodnoty pro klasifikace