Test-Driven Approaches to Documenting RESTful APIs (for Groovy/Java)
by Jennifer Strater
Sat, Apr 16, 2016
Room:
Rapson 54
Time:
11:00
Documentation generated from source code is very popular. Solutions such as Swagger are available for many different languages and frameworks. However, limitations of annotation based tools are becoming apparent. An overwhelming number of documentation annotations make for great docs but muddy the source code. Then, something changes and the docs are out of date again.
That is where test-driven approaches come in.
Test-driven documentation solutions, such as Spring Rest Docs, generate example snippets for requests and responses from tests ensuring both code coverage and accurate documentation. It can even fail the build when documentation becomes out of date. This session will walk through how to implement test-driven documentation solutions for groovy ecosystem technologies like Spring Boot and Grails. Attendees should have a basic understanding of AsciiDoc and how to construct RESTful APIs in Spring Boot and/or Grails.
That is where test-driven approaches come in.
Test-driven documentation solutions, such as Spring Rest Docs, generate example snippets for requests and responses from tests ensuring both code coverage and accurate documentation. It can even fail the build when documentation becomes out of date. This session will walk through how to implement test-driven documentation solutions for groovy ecosystem technologies like Spring Boot and Grails. Attendees should have a basic understanding of AsciiDoc and how to construct RESTful APIs in Spring Boot and/or Grails.
About the Author
Jennifer "Jenn" Strater is currently a Senior Consultant at Object Partners and co-founder of Gr8Ladies. She's an experienced Groovy and Grails developer and is an active participant in the Gr8 (Groovy, Grails, Griffon, Gradle, etc) community. She regularly attends the local user group, GroovyMN, and annual conferences including Gr8ConfUS. Jenn has presented introductory interactive sessions at various Minnesota tech events including as part of the Gr8Workshops initiative and internationally at Greach, Gr8Conf EU, Gr8Conf US, and Devoxx Belgium.