OpenAPI-kontrakt
Generér en typet klient i dit sprog ud fra OpenAPI-dokumentet, og validér forespørgsler mod det.
AVS, AutoUncle Vehicle Schema, er et åbent, versioneret JSON Schema til at beskrive en bil: hvad den er, hvordan den er bygget, og hvilket udstyr den har. Brug det i dine egne systemer, validér det i syv sprog, og byg på et API, der bruger samme identitetsmodel.
AVS har to slags dokumenter: et typedokument beskriver en bil, som den er bygget, for eksempel en BMW 320e G20 sedan med M Sport; et køretøjsdokument beskriver én fysisk bil af den type, med stelnummer, kilometertæller, farve og historik. Licenseret under Apache-2.0 og uden katalogdata.
AVS siger, hvad bilen er. Hvad den er værd, og hvor den er til salg, hører hjemme andetsteds.
Kun mærke og model er påkrævet. Intet gættes, og fravær skal angives eksplicit.
Hver katalogpost angiver sine ID'er i et hvilket som helst skema, for eksempel AutoUncle, Wikidata eller KBA HSN/TSN, og intet af dem er foretrukket.
Enheder er en del af feltnavnene, værdier følger EU's typeattest (CoC) og WLTP, og lande, valutaer og stelnumre bruger ISO-koder.
{
"avs": { "version": "0.3", "kind": "type" },
"identity": {
"brand": {
"name": "BMW",
"ids": [
{ "scheme": "autouncle", "value": "b-example0001" },
{ "scheme": "wikidata", "value": "Q26678" }
]
},
"model": {
"name": "3 Series",
"localNames": { "DK": "3-serie" }
},
"generation": { "name": "3 Series (G20/G21)", "code": "G20" },
"drivetrain": {
"name": "320e (204 Hp) Plug-in Hybrid Steptronic"
}
},
"specification": {
"powertrain": {
"energy": ["petrol", "electricity"],
"electrification": "phev",
"powerKw": 150, "torqueNm": 300
}
},
"equipment": {
"trim": {
"name": "M Sport",
"variations": ["M Sportpakke", "M-Sport"]
}
}
}
Mærke, model, generation og fase, derefter karrosseri og drivlinje som uafhængige fakta, og udstyrsniveau, pakker og ekstraudstyr ved navn. Vores API'er identificerer biler ad samme vej, fra mærke og model til generation, motorvariant og udstyrsniveau, med faste ID'er, du kan gemme i AVS under skemaet autouncle.
Hver pakke samler skemaet og en validator, der returnerer hver fejl med en JSON Pointer til stedet. Pakkerne genereres ud fra skemaet, skrives aldrig i hånden, og deres version er altid den samme som skemaets.
| Sprog | Pakke | Validér |
|---|---|---|
| Ruby | autouncle-avs | AVS.validate(doc) |
| TypeScript / JavaScript | @autouncle/avs | validate(doc) |
| Python | autouncle-avs | avs.validate(doc) |
| Go | github.com/AutoUncle/avs/packages/go | avs.Validate(b) |
| Java / JVM | com.autouncle:avs | Avs.validate(json) |
| .NET | AutoUncle.Avs | AvsSchema.Validate(json) |
| PHP | autouncle/avs | Avs::validate($doc) |
Generér en typet klient i dit sprog ud fra OpenAPI-dokumentet, og validér forespørgsler mod det.
Fejl er problemdokumenter efter RFC 9457 med en fast kode, en henvisning til feltet og et forslag til løsning.
Lande efter ISO 3166, valutaer efter ISO 4217 og stelnumre efter ISO 3779, i forespørgsler og resultater.
Hver vurdering tager en idempotensnøgle, så en gentaget forespørgsel aldrig afregnes to gange.
Det samme API som værktøjer til AI-agenter, plus et integrations-skill og llms.txt til kodeassistenter.
Læs skemaet, generér en klient ud fra OpenAPI-kontrakten, og vurdér din første bil med en gratis testnøgle.