Webinar Replay: Documenting REST-ful APIs
Join the DZone community and get the full member experience.Join For Free
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
Published at DZone with permission of Pieter Humphrey, DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.