OpenAPI-Vertrag
Generieren Sie aus dem OpenAPI-Dokument einen typisierten Client in Ihrer Sprache und validieren Sie Anfragen dagegen.
AVS, das AutoUncle Vehicle Schema, ist ein offenes, versioniertes JSON Schema zur Beschreibung eines Autos: was es ist, wie es gebaut ist und womit es ausgestattet ist. Nutzen Sie es in Ihren eigenen Systemen, validieren Sie es in sieben Sprachen und bauen Sie auf einer API auf, die dasselbe Identitätsmodell spricht.
AVS kennt zwei Arten von Dokumenten: Ein Typdokument beschreibt ein Auto, wie es gebaut wird, etwa einen BMW 320e G20 Limousine mit M Sport; ein Fahrzeugdokument beschreibt ein einzelnes physisches Auto dieses Typs, mit FIN, Kilometerstand, Farbe und Historie. Lizenziert unter Apache-2.0, ohne Katalogdaten.
AVS sagt, was das Auto ist. Was es wert ist und wo es zum Verkauf steht, gehört woandershin.
Nur Marke und Modell sind Pflicht. Nichts wird geraten, und dass etwas fehlt, muss ausdrücklich angegeben werden.
Jeder Katalogeintrag führt seine IDs in beliebigen Schemata, etwa AutoUncle, Wikidata oder KBA-HSN/TSN, und keines ist bevorzugt.
Einheiten sind Teil der Feldnamen, Werte folgen der EU-Übereinstimmungsbescheinigung (CoC) und WLTP, und Länder, Währungen und FINs nutzen ISO-Codes.
{
"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"]
}
}
}
Marke, Modell, Generation und Phase, dann Karosserie und Antrieb als unabhängige Fakten, und Ausstattungslinie, Pakete und Optionen beim Namen. Unsere APIs identifizieren Autos entlang desselben Pfads, von Marke und Modell zu Generation, Motorisierung und Ausstattungslinie, mit stabilen IDs, die Sie in AVS unter dem Schema autouncle speichern können.
Jedes Paket bündelt das Schema und einen Validator, der jeden Fehler mit einem JSON Pointer auf die Fundstelle zurückgibt. Die Pakete werden aus dem Schema generiert, nie von Hand geschrieben, und ihre Version entspricht immer der des Schemas.
| Sprache | Paket | Validieren |
|---|---|---|
| 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) |
Generieren Sie aus dem OpenAPI-Dokument einen typisierten Client in Ihrer Sprache und validieren Sie Anfragen dagegen.
Fehler sind Problem-Dokumente nach RFC 9457 mit stabilem Code, einem Verweis auf das Feld und einem Lösungsvorschlag.
Länder nach ISO 3166, Währungen nach ISO 4217 und FINs nach ISO 3779, in Anfragen und Ergebnissen.
Jede Bewertung akzeptiert einen Idempotenzschlüssel, sodass eine wiederholte Anfrage nie doppelt berechnet wird.
Dieselbe API als Tools für KI-Agenten, dazu ein Integrations-Skill und llms.txt für Coding-Assistenten.
Lesen Sie das Schema, generieren Sie einen Client aus dem OpenAPI-Vertrag und bewerten Sie Ihr erstes Auto mit einem kostenlosen Testschlüssel.