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

Webinar Replay: Documenting REST-ful APIs

DZone's Guide to

Webinar Replay: Documenting REST-ful APIs

· Java Zone
Free Resource

In this complimentary, preview edition of the O’Reilly eBook on cloud-native Java, discover how Spring and Cloud Foundry make it easy to build cloud-native applications that create differentiated business value.  Brought to you in partnership with Pivotal.

Speaker: Andy Wilkinson

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 webinar we'll look at what should be included in your RESTful API's documentation and, just as importantly, what should be omitted. To illustrate this we'll look at some real-world examples of good and bad API documentation. We'll look at some of the problems and limitations of choosing a tool like Swagger to produce your API's documentation and conclude by looking at some alternatives that are better-suited to producing documentation that your users will love.

Learn more about Spring MVC http://projects.spring.io/spring-framework

Learn more about Spring REST Docs https://github.com/wilkinsona/spring-restdocs

Read how Cloud Foundry, Spring Boot, and Spring Cloud offer the best tools to commoditize the architecture of the cloud. Download the free O’Reilly eBook today.  Brought to you in partnership with Pivotal.

Topics:

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 }}