Spring Framework: Documenting Spring Data Rest APIs with Swagger and Springfox

Swagger allows you to generate documentation from code. It also provides a web app to display documentation with a built-in REST client to test endpoints. This course shows you how to use Swagger and Springfox in your Spring Data REST API project.
Course info
Rating
(33)
Level
Advanced
Updated
Mar 9, 2020
Duration
29m
Table of contents
Description
Course info
Rating
(33)
Level
Advanced
Updated
Mar 9, 2020
Duration
29m
Description

Documenting your API can sometimes feel like a losing battle between keeping it up to date with changes, figuring out what format to use, and how to host it. In this course, Spring Framework: Documenting Spring Data REST APIs with Swagger and Springfox, you will gain foundational knowledge of Documenting your APIs automatically. First, you will learn about Swagger and the tools it provides. Next, you will discover how to integrate Swagger and Springfox into your Spring Data REST project. Finally, you will explore how to customize your documentation and handle versioning. When you are finished with this course, you will have the skills and knowledge of Swagger and Springfox needed to automatically generate and host documentation for your Spring Data REST API.

About the author
About the author

Craig is passionate about solving problems with the right tools. He has a bachelor's and master's degree in computer science with extensive experience in AWS, microservices, and artificial intelligence. Craig enjoys teaching and mentoring others so they can save time and accomplish their goals faster.

More from the author
More courses by Craig Golightly
Section Introduction Transcripts
Section Introduction Transcripts

Course Overview
Hi, everyone. My name is Craig Golightly, and welcome to my course, Spring Framework: Documenting Spring Data REST APIs with Swagger and Springfox. I am a senior software consultant. Documenting your API can sometimes feel like a losing battle, keeping it up to date with changes, figuring out what format to use, and where to host it. The good news is that there is an easier way. In this course, you'll explore how Swagger and Springfox can automatically generate documentation for your Spring Data REST API and make it available on a web page that is also a REST client. Not only will you be able to read the documentation, you can actually try out the endpoints. Some of the major topics that we will cover include the Swagger framework, adding Swagger to your project, customizing your documentation, and documenting different versions of your API. By the end of this course, you will be able to quickly and easily generate documentation for your Spring Data REST API using Swagger and Springfox. Before beginning the course, you should be familiar with Spring Data and REST APIs. I hope you'll join me on this journey to learn about documenting REST APIs with the Spring Framework: Documenting Spring Data REST APIs with Swagger and Springfox course, at Pluralsight.