Documenting RESTful Services Using Spring REST Docs 3

Documentation is a vital part of any RESTful API, but it can
be difficult to integrate it into your development process.
This course will teach you how to use Spring REST Docs to
seamlessly weave documentation into the test cases for
your code.

Documenting REST APIs is necessary, but it is often viewed as a daunting, distracting task for developers. In this course, Documenting RESTful Services Using Spring REST Docs 3, you’ll learn how to seamlessly integrate documentation into your test cases. First, you’ll explore the set up and basics of the Spring REST Docs project. Next, you’ll discover how to add detailed documentation to your APIs easily through small tweaks to your tests. Finally, you’ll learn how to build full documentation webpages with Asciidoc or Markdown, and even how to generate OpenAPI artifacts to unlock even more functionality. When you’re finished with this course, you’ll have the skills and knowledge of Spring REST Docs needed to productively make documentation a part of your development process.

• Course Overview 2mins
• Providing Documentation for RESTful APIs 22mins
• Integrating Documentation and Testing 29mins
• Documenting Request and Response 35mins
• Configuring and Customizing Your Documentation 29mins
• Finalizing Your Documentation with AsciiDoc or Markdown 40mins
• Generating REST Clients through OpenAPI with restdocs-api-spec 23mins