AsciiDoc – Tworzymy dokumentacje

Artykuł ten powiązany jest z poprzednim wpisem na temat Spring Rest Docs, czyli automatycznego generowania dokumentacji na podstawie testów. Dzięki Spring Rest Docs generowane były snippety, czyli fragmenty dokumentacji, które następnie umieszczało się w pliku zbiorczym z rozszerzeniem adoc. Na końcu należało te fragmenty ładnie opakować korzystając ze składni AsciiDoc’a.

Czytaj dalej


#18 Spring Boot – TDDocumentation – Spring Rest Docs

Pamiętacie wpis o najlepszych praktykach REST’owych? Jedną z wyszczególnionych tam praktyk było dokumentowanie naszego API. Wymieniłem tam także kilka najpopularniejszych rozwiązań. Jedno z nich, czyli Swagger opisałem już na blogu w artykule #10 Spring Boot – Swagger2 – dokumentujemy API. Dziś czas na kolejne podejście do dokumentacji, tym razem od strony testów. Test Driven Documentation jest techniką,

Czytaj dalej