W-JAX 2015 Session

REST-Architekturen erstellen und dokumentieren

Redaktion JAXenter

In Büchern und Vorträgen über REST wird der Dokumentation wenig bis gar keine Aufmerksamkeit geschenkt. Wie wichtig die Dokumentation von Schnittstellen jedoch ist, erleben wir alle immer wieder im Alltag. In seiner Session auf der W-JAX konzipierte und erstellte Martin Walter einen kleinen REST-Service, an dessen Beispiel er verschiedene Tools vorstellte, mit denen (interaktive) REST-Service-Dokumentationen erstellt werden können.

Eine gute Dokumentation zu schreiben, ist schwierig, da sie stark von der Anwendung abhängt, die erstellt wurde. REST-Services bilden in Sachen Dokumentation eine Ausnahme, da sie grundlegend einen immer gleichen Aufbau besitzen und die Dokumentationserstellung erheblich durch Automatisierungsprozesse beschleunigt werden kann.

REST-Architekturen erstellen und dokumentieren from JAX TV on Vimeo.

Martin Walter (sw-b)Martin Walter ist nach dem Studium der Medieninformatik an der Universität Ulm und der freiberuflichen Tätigkeit als Webentwickler und Consultant mittlerweile als Software-Architekt bei der Deutschen Welle, einem der großen internationalen Broadcaster. Daneben ist er immer noch als Consultant und Referent auf Konferenzen unterwegs.
Geschrieben von
Kommentare
  1. Sezgin Ruhi2016-06-07 11:19:20

    Schade das hier RAML nicht besprochen wurde. http://raml.org/

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.