Chapter 6. Documenting and versioning a Restlet application

 

This chapter covers
  • Documenting your web API
  • When to version your web API
  • Web Application Description Language (WADL)

 

Now that you’ve seen how to secure Restlet applications, it’s time to continue your exploration of the tasks required to get ready to roll out. This chapter covers how to document and version the RESTful web API of your Restlet application.

First we discuss the use cases, pitfalls, and recommendations when documenting and versioning your web API. Documenting is essential in helping a development team communicate during active development or maintenance and helping users learn how to use it. Versioning ensures that existing clients won’t break and alienate your ...

Get Restlet in Action: Developing RESTful web APIs in Java now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.