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.
What you'll learn
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.
Table of contents
- Snippet Formats 2m
- Field Constraints 4m
- Snippet Templates 3m
- Custom Snippet Templates 2m
- Demo: Using Custom Templates for Field Constraints 4m
- Demo: Using Custom Templates for Query Parameters 3m
- Configuring the Default Snippets 1m
- Request and Response Preprocessors 4m
- Demo: Default Snippets Configuration 4m
- Demo: Request and Response Preprocessors 3m
- Summary 1m
- AsciiDoc 3m
- Basic Formatting 4m
- AsciiDoc Lists 3m
- More on AsciiDoc Lists 6m
- AsciiDoc Tables 4m
- Including Files and Creating Table of Contents 4m
- AsciiDoc Usage with Spring REST Docs 4m
- Demo: Creating the AsciiDoc Website 4m
- Demo: AsciiDoc and DocInfo 3m
- Demo: AsciiDoc and Option Attributes 2m
- Demo: Browsing the Final Website 4m
- Summary 1m
- Introduction to OpenAPI 3m
- Using OpenAPI in Spring Boot with SpringDoc 2m
- Demo: Spring Doc 4m
- OpenAPI vs. Spring REST Docs 3m
- Bringing It All Together with REST Docs API Spec 3m
- Demo: Prepare the Project for REST Docs API Spec 4m
- Demo: Run the Project with REST Docs API Spec 2m
- Summary and Wrap-up 2m
About the author
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