Tuetut tyypit ja JSON-skeemat
Tällä sivulla
Skeemojen rakennuspalikat
Vastauksiesi rakenteen määrittelyyn käytössäsi on seitsemän JSON-tyyppiä. Jokainen niistä palvelee erityistä tarvetta datan mallinnuksessa. Näiden tyyppien ymmärtäminen on välttämätöntä tehokkaiden skeemojen suunnittelussa.
Seitsemän tuettua tyyppiä
string
Yleisin tyyppi. Käytetään nimiin, kuvauksiin, tunnisteisiin ja kaikkeen tekstimuotoiseen sisältöön.
{
"type": "object",
"properties": {
"name": { "type": "string" },
"description": { "type": "string" }
}
}
number
Kattaa kokonaisluvut ja liukuluvut. Eroa integer- ja float-tyyppien välillä ei ole – yksi number-tyyppi hoitaa molemmat.
{
"properties": {
"price": { "type": "number" },
"quantity": { "type": "number" }
}
}
boolean
Tosi tai epätosi. Täydellinen lippuihin, validointeihin ja binäärisiin päätöksiin.
{
"properties": {
"in_stock": { "type": "boolean" },
"express_delivery": { "type": "boolean" }
}
}
object
Mahdollistaa rakenteiden sisäkkäisyyden. Objekti voi sisältää muita objekteja, taulukoita tai skalaareja – syvyydelle ei ole rajoitusta.
{
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"street": { "type": "string" },
"city": { "type": "string" },
"postal_code": { "type": "string" }
}
}
}
}
array
Saman tyyppisten alkioiden listoja. Voit luoda merkkijonojen, lukujen, objektien tai jopa taulukoiden taulukoita.
{
"properties": {
"skills": {
"type": "array",
"items": { "type": "string" }
}
}
}
enum
Äärellinen joukko sallittuja arvoja. Välttämätön kategorisoinnille ja luokittelulle.
{
"properties": {
"priority": {
"type": "string",
"enum": ["low", "medium", "high", "critical"]
}
}
}
anyOf
Mahdollistaa tyyppiyhdistelmien määrittelyn. Kenttä voi hyväksyä useita erilaisia rakenteita. Hyödyllinen, kun yksittäinen kenttä voi esiintyä eri muodoissa.
{
"properties": {
"contact": {
"anyOf": [
{
"type": "object",
"properties": {
"email": { "type": "string" }
}
},
{
"type": "object",
"properties": {
"phone": { "type": "string" }
}
}
]
}
}
}
Tyyppien yhdistäminen
Skeemojen voima piilee näiden tyyppien yhdistämisessä. Tässä on realistinen skeema tuotteen analysointiin:
{
"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" }
}
}
}
}
Tämä skeema yhdistää skalaareja, enum-arvon, taulukon ja sisäkkäisen objektin. Malli noudattaa jokaista rajoitetta jokaisessa kutsussa.
Valinnaiset kentät
Teet kentästä valinnaisen käyttämällä anyOf:a yhdessä null:n kanssa:
{
"properties": {
"phone": {
"anyOf": [
{ "type": "string" },
{ "type": "null" }
]
}
}
}
Pydanticissa tämä vastaa merkintää phone: str | None.
Keskeiset asiat
- Seitsemän käytettävissä olevaa tyyppiä:
string,number,object,array,boolean,enum,anyOf - Tyypit yhdistyvät vapaasti monimutkaisten rakenteiden mallintamiseen
- Valinnaiset kentät toteutetaan käyttämällä
anyOf:a yhdessänull:n kanssa - Kokonaislukujen ja liukulukujen välillä ei ole eroa – yksi
number-tyyppi riittää enumpakottaa käyttämään ennalta määriteltyjä arvoja luokittelussa