Documenting RESTful APIs
API documentation is hugely essential. Learn more about RESTful API documentation in this cool talk from Andy Wilkinson.
Join the DZone community and get the full member experience.Join For Free
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.
Speaker: Andy Wilkinson
Published at DZone with permission of Pieter Humphrey, DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.
Effortlessly Streamlining Test-Driven Development and CI Testing for Kafka Developers
The SPACE Framework for Developer Productivity
Design Patterns for Microservices: Ambassador, Anti-Corruption Layer, and Backends for Frontends
A Complete Guide to AWS File Handling and How It Is Revolutionizing Cloud Storage