Dokumentation von REST-APIs 13.02.2017, 11:36 Uhr

Formate und Tools

REST-APIs lassen sich einfacher implementieren, wenn man sie richtig dokumentiert.
Ein gutes und durchdachtes REST-API beginnt mit einer guten und durchdachten Dokumentation. Bevor es an die Implementierung geht, ist es daher empfehlenswert, sich genau zu überlegen, wie das zu entwickelnde API aufgebaut sein soll. So lassen sich konzeptionelle Schwachstellen oder Designfehler in einem API frühzeitig erkennen und beheben.
Mittlerweile gibt es diesbezüglich einige interessante Formate und Tools, die das Planen, Entwerfen, Dokumentieren und sogar das Testen von REST-APIs erleichtern beziehungsweise unterstützen können. Die bekanntesten davon seien im Folgenden kurz vorgestellt: die RESTful API Modeling Language (kurz RAML), API Blueprint, Open API (auch bekannt als Swagger) sowie APIDOC.

web & mobile DEVELOPER

Sie wollen zukünftig auch von den Vorteilen eines plus-Abos profitieren? Werden Sie jetzt web&mobile Developer plus Kunde.
  • 2 Monate Gratis testen
  • Über 4.000 qualifizierte Fachartikel
  • Diverse DevBooks thematisch für Sie zusammen gestellt
  • Webcasts von 30 - 90 Min.
  • Aufzeichnungen von ausgewählten Fortbildungen und Konferenzen
  • Auf jedem Gerät verfügbar