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

Documenting RESTful APIs

DZone's Guide to

Documenting RESTful APIs

API documentation is hugely essential. Learn more about RESTful API documentation in this cool talk from Andy Wilkinson.

· Integration Zone
Free Resource

Modernize your application architectures with microservices and APIs with best practices from this free virtual summit series. Brought to you in partnership with CA Technologies.

An API’s documentation is a vital part of making it easy to understand and easy to use. RESTful APIs are no different. In this talk we’ll look at what should be included in your RESTful API’s documentation and, just as importantly, what should be omitted. Using real-word examples, both good and bad, we’ll discuss how the documentation should be structured so that it’s informative, succinct, and easy to read. Having identified what good documentation looks like, we’ll discuss some of the tools that are available for documenting services built using Spring. In particular, we’ll look at some of the problems and limitations of choosing a tool like Swagger and how some alternatives, including Spring REST Docs, avoid these shortcomings and help you to produce documentation that your users will love.


Recorded at SpringOne2GX 2015.

Track: Web/Javascript Track
Speaker: Andy Wilkinson
Slides: http://www.slideshare.net/SpringCentral/documenting-restful-apis

The Integration Zone is proudly sponsored by CA Technologies. Learn from expert microservices and API presentations at the Modernizing Application Architectures Virtual Summit Series.

Topics:
springone ,spring ,java ,rest 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.

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

{{ parent.tldr }}

{{ parent.urlSource.name }}