API Review von REST Schnittstellen

Das Erstellen eines REST Service ist einfach. Dass diese Schnittstelle auch problemlos von Client-Entwicklern aufgerufen werden kann ist nicht ganz so einfach. Intuitive, selbsterklärende und schlanke Schnittstellen zu entwickeln ist eine Herausforderung.

Die Investition in eine gut entworfene Schnittstelle zahlt sich aus durch:

  • Eine Zeitersparnis bei der Entwicklung von Clients
  • Einfachere Erweiterbarkeit der Schnittstelle
  • Weniger Aufwände bei der Versionierung
  • Ersparnis beim Support

Sichern Sie sich die Qualität Ihrer Schnittstellen mit einem Review.

Ein Review beantwortet u.a. die Fragen:

  • Wurden Namensmuster verwendet und wurden diese konsequent eingehalten?
  • Wurde gegen die REST Prinzipien verstoßen?
  • Werden die richtigen HTTP Status Codes verwendet?
  • Werden die Parameter an der jeweils passenden Stelle wie z.B. im Path oder Header übergeben?
  • Werden passende Status Codes verwendet?

und zeigt Vorschläge zur:

  • Umbenennung von Resource, JSON Strukturen, ...
  • Umstrukturierung
  • Verbesserung der Modellierung der JSON Strukturen

Wie läuft ein Review ab

Sie schicken:

  • eine Beschreibung der Schnittstelle z.B. mit Swagger oder WADL
  • den Code
  • oder Beispiele von HTTP Anfragen und Antworten

an info@predic8.de. Danach beginnen wir mit dem Review oder melden uns um weitere Unterlagen anzufordern.

Nach wenigen Tagen bekommen Sie ein Review Dokument mit detailierten Informationen, Bewertungen und Vorschlägen. Ferner erhalten Sie ein optimiertes Swagger Dokument oder Bespielnachrichten.