OpenAPI
OpenAPI ist ein maschinenlesbares Schema, das jeden Endpunkt, Parameter und jede Antwort einer REST-API beschreibt und Clients generierbar macht.
Im Detail
Diese API veröffentlicht ein OpenAPI-3.1-Dokument neben einem llms.txt-Index, wodurch ein SDK-Generator, eine Postman-Sammlung oder ein Agenten-Framework die Oberfläche verstehen kann, ohne dass jemand zuerst Prosa lesen muss. Es ist die maßgebliche Quelle für Anfrageformate und Statuscodes. Verhaltensänderungen werden vor dem Ausrollen im Changelog angekündigt, ein generierter Client lässt sich also bewusst neu erzeugen, statt kaputt entdeckt zu werden.
Auch bekannt als
- swagger
- api schema