API Conference
The Conference for Web APIs, API Design & Management

Test Driven Documentation: Documenting RESTful APIs with Spring REST Docs

Logo API Conference

Documentation generated from source code is very popular and solutions such as Swagger are available for many different languages and frameworks. However, limitations of annotation-based tools are becoming more apparent. Enter test-driven approaches; In her session at the API Conference 2017 in Berlin, Jennifer Strater (Senior Engineer at Zenjob) shows how to implement test-driven documentation solutions.

An overwhelming number of documentation annotations make for great docs but “they don’t necessarily have a good impact on source code”. Then, something changes and the docs are out of date again. That is where a test-driven approach comes in handy. 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 you through how to implement test-driven documentation solutions.


All News & Updates of API Conference:

Behind the Tracks

API Management

A detailed look at the development of APIs

API Development

Architecture of APIs and API systems

API Design

From policies and identities to monitoring

API Platforms & Software as a Service

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