Session Details

API Conference 2018
The Conference for Web APIs, API Design & Management
April 11 - 13, 2018 in London

Jennifer Strater

en

20 Sep 2017
12:15 - 13:15
Till December 21 ✓ Workshop Day for free ✓ save up to 515 £ ! ✓ Group Discount Register now

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

20 Sep 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.

Session Tracks

#API Management

All News & Updates of API Conference 2018:

Behind the Tracks

Web API Development

Ein detaillierter Blick auf die Entwicklung von APIs

API Design & Microservices

Architektur von APIs und API-Systemen

API Management

Von Policys und Identitys bis Monitoring