Die RESTful API wird mit dem OpenAPI Standard (ehemals Swagger) dokumentiert. Jede ChurchTools Installation wird mit der Dokumentation ausgeliefert und kann über einen Link wie https://meine-gemeinde.church.tools/api aufgerufen werden.
Die Dokumenation ist mit der Swagger-UI in ChurchTools integriert. Das bietet folgende Vorteile:
- Einfacher Überblick über alle verfügbaren Endpoints
- Testen: Die UI erlaubt es, direkt im Browser Requests abzufeuern und so die API zu testen
- ChurchTools-User: Ist man in ChurchTools eingeloggt, werden alle Requests über die UI direkt mit dem eigenen Benutzer gesendet. So kann man die API schnell und einfach testen.
API-Spezifikation als JSON-Datei #
Durch den Standard ist es möglich, die ganze Dokumentation als JSON-Datei für eigene Projekte heranzuziehen. Die ganze Spezifikation ist über den Link https://meine-gemeinde.church.tools/system/runtime/swagger/openapi.json erreichbar.