Jennifer Straters Session von der API Conference 2017

Testgetriebene Dokumentation: RESTful APIs mit Spring REST Docs dokumentieren

Redaktion JAXenter

Dokumentationen, die direkt aus dem Quelltext heraus generiert werden, erfreuen sich wachsender Beliebtheit. Um dies durchzuführen, gibt es Lösungen für viele verschiedene Sprachen und Frameworks, ein Beispiel dafür ist Swagger. Nun werden die Grenzen von Tools, die auf Annotationen basieren, allerdings immer offensichtlicher. Hier kommen testgetriebene Ansätze ins Spiel. In ihrer Session von der API Conference 2017 zeigt Jennifer Strater, Senior Engineer bei Zenjob, Schritt für Schritt, wie man diese testgetriebenen Dokumentationslösungen implementiert.

Eine überwältigende Anzahl von Dokumentationsannotationen sorgen für gute „Docs“, verschmutzen aber den Quelltext. Wenn dann etwas geändert wird, ist die Dokumentation wieder nicht mehr up-to-date, deshalb lohnt sich ein testgetriebener Dokumentationsansatz. Testgetriebene Dokumenationslösungen wie Spring REST Docs erstellen Beispiel-Snippets für Requests und entsprechende Antworten von Tests, wodurch sowohl die Code Coverage und eine akkurate Dokumentation sichergestellt werden. Ist die Dokumentation veraltet, kann sogar der Build fehlschlagen.

Jennifer “Jenn” Strater is the co-founder of the organization Gr8Ladies and a senior engineer at Zenjob in Berlin. She has also organized Gr8Workshops for developers interested in an overview and crash course in Groovy technologies. Previously, she worked as a consultant and engineer in the US and has presented at events such as the Grace Hopper Celebration of Women in Computing, Greach, Gr8Conf EU, US, JFokus, and Devoxx Belgium.
Geschrieben von
Kommentare

Schreibe einen Kommentar

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