OpenAPI & API-Design
Schnittstellen, die vor der ersten Code-Zeile feststehen – und die Partner ohne Rückfragen anbinden können.
dectria entwirft Schnittstellen mit OpenAPI und arbeitet dabei meist Spec-first: Die Spezifikation entsteht vor dem Code und ist der gemeinsame Vertrag für Frontend, Backend und Integrationspartner.
Aus der Spezifikation erzeugen wir typsichere Clients für das Frontend und Schnittstellen für das Backend. Redocly stellt sie als lesbare Dokumentation bereit, die Partner vom ersten Tag an nutzen können.
Für bestehende Schnittstellen ohne Dokumentation erstellen wir die Spezifikation nachträglich und prüfen sie automatisch gegen die laufende API.
Offizielle Website
Ihr Ansprechpartner Michael Jauk Ansprechpartner für Backend & Architektur 
Was ist OpenAPI – und wann lohnt es sich?
OpenAPI ist ein offener Standard, mit dem sich REST-Schnittstellen maschinenlesbar beschreiben lassen: Endpunkte, Parameter, Datenformate und Fehler. Aus einer OpenAPI-Spezifikation lassen sich Dokumentation, Clients, Tests und Mock-Server erzeugen. Der frühere Name ist Swagger.
OpenAPI lohnt sich, sobald mehr als ein Team oder ein externer Partner eine Schnittstelle nutzt. Spec-first lohnt sich weniger bei internen Endpunkten, die nur eine einzige Oberfläche bedient und die sich täglich ändern – dort genügt eine aus dem Code erzeugte Beschreibung.
Spec-first oder Code-first?
| Spec-first | Code-first | |
|---|---|---|
| Quelle der Wahrheit | die OpenAPI-Spezifikation | der Code, die Spezifikation wird daraus erzeugt |
| Paralleles Arbeiten | Frontend, Backend und Partner starten gleichzeitig | Frontend wartet auf das Backend |
| Abstimmung | vor der Umsetzung, auf Basis der Spezifikation | nach der Umsetzung, auf Basis des Codes |
| Geeignet für | Schnittstellen für Partner und mehrere Teams | interne Endpunkte für eine einzige Oberfläche |
Verwandte Themen
Kompetenzen
Was wir mit OpenAPI / Swagger umsetzen
Einsatzgebiete
Typische Anwendungsfälle
Schnittstellen für Integrationspartner
Partner erhalten Spezifikation und Dokumentation, bevor die API fertig ist, und können ihre Anbindung parallel entwickeln.
Frontend und Backend parallel entwickeln
Das Frontend arbeitet gegen einen Mock-Server aus der Spezifikation, während das Backend entsteht.
Bestehende APIs dokumentieren
Undokumentierte Schnittstellen erhalten eine Spezifikation, die automatisch gegen die laufende API geprüft wird.
Häufige Fragen
FAQ zu OpenAPI / Swagger
Warum arbeitet dectria Spec-first?
Wie wird aus der Spezifikation Code?
Kann dectria bestehende APIs dokumentieren?
Wie bleiben API-Änderungen abwärtskompatibel?
Jedes Projekt beginnt mit einem Gespräch.