Ibexa DXP 5: Einführung von OpenAPI für REST-API-Endpunkte
Konnektivität ist eine Grundvoraussetzung für jede moderne Webplattform. Ibexa DXP unterstützt seit seiner Einführung die Fernnutzung umfassend über HTTP-basierte APIs. Dennoch gibt es immer Raum für Verbesserungen. Daher freuen wir uns, mit Version 5 die OpenAPI-Kompatibilität ankündigen zu können.
OpenAPI ist ein Standard zur einheitlichen Beschreibung verfügbarer REST-Endpunkte. Er legt nicht fest, wie die APIs funktionieren sollen, sondern bietet eine Struktur, um die vorhandenen Funktionen und deren Arbeitsweise darzustellen. Das ist besonders nützlich, um Code und Benutzeroberflächen zu generieren, die Entwicklern eine einfache Entdeckung der APIs ermöglichen.
Die REST- und GraphQL-APIs werden in Projekten häufig eingesetzt.
Als Entwicklerplattform muss Ibexa DXP dies berücksichtigen. Es ist wichtig zu betonen, dass die API-Endpunkte weiterhin wie gewohnt funktionieren werden. Die Einführung von OpenAPI bringt somit keine „Breaking Changes” mit sich.
Sie können sich darauf verlassen, dass Sie sich bei einem Upgrade von Ibexa DXP 4.6 LTS oder einer älteren Version auf andere Verbesserungen konzentrieren können.
OpenAPI wird standardmäßig in allen Editionen von Ibexa DXP ausgeliefert. Die Spezifikations- und Dokumentationsausgabe steht standardmäßig auf drei Arten zur Verfügung:
- Auf Ihrer Ibexa-DXP-Installation unter dem Pfad /api/ibexa/v2/doc
- Das REST-Schema wird als YAML exportiert, um von Tools verarbeitet zu werden
- Unsere öffentliche REST-API-Dokumentation wird mit Redoc aus Ibexa Commerce generiert
Mithilfe dieser Ressourcen können Entwickler und Anwendungen schnell mit den RESTful APIs von Ibexa DXP arbeiten. Die OpenAPI-Spezifikation ist in der Branche weit verbreitet und wird von zahlreichen Entwickler-Tools unterstützt.
Die Dokumentation macht die Nutzung benutzerdefinierter REST-Anfragen in QNTM Connect so einfach wie nie zuvor. Das eigentliche Potenzial liegt jedoch in der Automatisierung. Da der Standard die Funktionen der Plattform beschreibt, können Programmierassistenten und KI-Agenten die Spezifikation nutzen, um sich mit diesen vertraut zu machen.
Leistungsstarke öffentliche APIs sind ein potenzielles Ziel für Hacker. Da das OpenAPI-Schema jedoch lediglich eine Referenz aller Funktionen darstellt, sind Sie durch die von Ibexa DXP bereitgestellten Sicherheitsvorkehrungen geschützt.
Durch einen gut eingeschränkten API-Benutzer für allgemeine Anfragen und sorgfältig ausgestaltete Berechtigungen für einzelne Benutzergruppen kann dies nicht als Angriffsvektor genutzt werden.