Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Writing Comprehensive, Guaranteed, Up-to-Date REST API Documentation [Video]

DZone's Guide to

Writing Comprehensive, Guaranteed, Up-to-Date REST API Documentation [Video]

RESTful API documentation is often a topic of frustration for API developers and users. It doesn't have to be this way! Spring REST docs can help.

· Integration Zone
Free Resource

Discover how Microservices are a type of software architecture where large applications are made up of small, self-contained units working together through APIs that are not dependent on a specific language. Brought to you in partnership with AppDynamics.

RESTful APIs are eating the world — yet all too often, the documentation can cause indigestion for the API developers and users. Developers have to deal with annotation overload, repetition, and an unpleasant writing environment. Users are then left with documentation that’s inaccurate and difficult to use. It doesn’t have to be this way.

This talk will introduce Spring REST docs and their test-driven approach to RESTful API documentation. We’ll look at how they combine the power of Asciidoctor and your integration tests to produce documentation that’s accurate and easy-to-read while keeping your code DRY and free from annotation overload. We’ll also look at some of the features that are new in Spring REST Docs 1.1, including support for REST Assured and Markdown.

You can check out the slides here, or view the video below.

Discover the six challenges and best practices in managing microservice performance, brought to you in partnership with AppDynamics.

Topics:
spring rest docs ,integration ,restful api ,documentation

Published at DZone with permission of Pieter Humphrey, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

The best of DZone straight to your inbox.

SEE AN EXAMPLE
Please provide a valid email address.

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.
Subscribe

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}