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

SpringOne2GX 2015 Replay: Documenting RESTful APIs

DZone's Guide to

SpringOne2GX 2015 Replay: Documenting RESTful APIs

Here's a look at documenting RESTful APIs, a critical aspect to understanding APIs and ensuring ease of use.

· Java Zone
Free Resource

Never build auth again! The Okta Developer Platform makes it simple to implement authentication, authorization, MFA and more in Java applications. Get started with the free API.

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

Build and launch faster with Okta’s user management API. Register today for the free forever developer edition!

Topics:
spring

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

Opinions expressed by DZone contributors are their own.

THE DZONE NEWSLETTER

Dev Resources & Solutions Straight to Your Inbox

Thanks for subscribing!

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

X

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

{{ parent.tldr }}

{{ parent.urlSource.name }}