API Conference 2020
The Conference for Web APIs, API Design & Management
April 20 - 22, 2020 in The Hague, Netherlands

A Test-driven Approach to Documenting RESTful APIs with Spring REST Docs

Session
This talk originates from the archive. To the CURRENT program
Until December 19
✓ Workshop Day for free ✓ Raspberry Pi or C64 Mini for free ✓ Save up to €584 Register now
Infos
Wednesday, September 20 2017
12:15 - 13:15

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. Attendees should have a basic understanding of a markdown like documentation tool such as AsciiDoc and how to construct RESTful APIs in a JVM ecosystem technology such as Spring Boot. Examples will be in Spring Boot and Groovy, but the concepts are applicable to other ecosystems too.

All News & Updates of API Conference 2019:

Behind the Tracks

API Management

A detailed look at the development of APIs

API Development

Architecture of APIs and API systems

API Design & Documentation

From policies and identities to monitoring

API Platforms & Software as a Service

Web APIs for a larger audience & API platforms related to SaaS