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.
Author Name: Federico Mestrone
Author Description:
Also known as Fed in the English-speaking world, Federico has an intriguing eclectic approach to technology. In love with it since he was 12 – back in the days of the Commodore 64 – he betrays it on a regular basis: first with ballet and contemporary dance, then with synchronised swimming, recently with Japanese language and culture. Mostly a Java/Scala developer and Linux/Mac OS user, over the course of 20+ years he has had commercial experience in several other platforms and programming langua… more

Table of Contents

• 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