Facilitating the Spread of Knowledge and Innovation in Professional Software Development

Write for InfoQ


Choose your language

InfoQ Homepage Presentations Documenting RESTful APIs

Documenting RESTful APIs



Andy Wilkinson talks about what should be included in your RESTful API's documentation and what should be omitted. Using real-word examples, both good and bad, he discusses how the documentation should be structured so that it's informative, succinct, and easy to read. He also discusses some of the tools that are available for documenting services built using Spring.


Andy Wilkinson is Spring Boot committer and Spring IO Platform lead at Pivotal, and iOS developer at DeftMethods.

About the conference

This is a one-of-a-kind conference for application developers, solution and data architects: people who develop business applications, create multi-device aware web applications, process vast quantities of enterprise data, design cloud architectures, and manage high performance infrastructure. The sessions are specifically tailored for Developers and Architects using the popular open source Spring IO Projects, Groovy & Grails, Cloud Foundry, RabbitMQ, Redis, Geode, Hadoop and Tomcat technologies. Whether you're building mission-critical web or business applications, crunching huge amounts of distributed data, or designing the next killer cloud native application, SpringOne2GX will keep you up to date with the latest enterprise technology.

Recorded at:

Jan 02, 2016