Suche

Spring REST Docs 1.0.0: Spring-Dokumentationen leicht gemacht

Kypriani Sinaris

©Spring-Logo (Quelle: spring.io)

Ein neues Major Release gibt es aus dem Spring-Universum zu vermelden: Spring REST Docs 1.0.0. ist erschienen. Das Projekt möchte der insgesamt wenig geliebten Arbeit des Schreibens von RESTful Services-Dokumentationen mithilfe eines testgetriebenen Ansatzes den Schrecken nehmen.

Wie in der Roadmap des Projekts angekündigt, liefert Pivotal pünktlich die Version 1.0.0. seines Spring-REST-Docs-Projekts ab. Spring REST Docs kombiniert selbstgeschriebene Dokumentation in Asciidoctor und auto-generierte Snippets, die mit Spring MVC Test produziert wurden.

Die Idee dahinter: Für jede Ressource wird ein Test geschrieben, der die zu erwartende Kombination aus Request und Response beschreibt. Treffen beide zu, wird automatisch eine Dokumentation im Asciidoctor-Format ausgegeben, die bei Bedarf um händisch erstellte Inhalte ergänzt werden kann. Die Dokumentation lehnt sich somit stark an reale Anwendungsfälle an, ähnelt GitHubs API-Dokumentation und grenzt sich von vollautomatisierten Dokumentationen, wie sie beispielsweise anhand von Tools wie Swagger erstellt werden können, ab.

Schon der RC1 ermöglichte die Dokumentation von Pfadparametern und Multipart-Requests. Außerdem werden per Bean Validation API deklarierte Constraints sowie Template-basiertes Snippet-Rendering unterstützt.

Spring REST Docs läuft unter der Apache-2.0-Lizenz. Um das Projekt zu nutzen, muss mindestens Java 7 vorliegen.

Verwandte Themen:

Geschrieben von
Kypriani Sinaris
Kypriani Sinaris
Kypriani Sinaris studierte Kognitive Linguistik an der Goethe Universität Frankfurt am Main. Seit 2015 ist sie Redakteurin bei JAXenter und dem Java Magazin.
Kommentare

Hinterlasse einen Kommentar

Hinterlasse den ersten Kommentar!

avatar
400
  Subscribe  
Benachrichtige mich zu: