From the course: Extending, Securing, and Dockerizing Spring Boot Microservices

Unlock the full course today

Join today to access over 22,400 courses taught by industry experts or purchase this course individually.

Documenting APIs with Swagger

Documenting APIs with Swagger

From the course: Extending, Securing, and Dockerizing Spring Boot Microservices

Start my 1-month free trial

Documenting APIs with Swagger

- [Instructor] API clients hunger for well-described interfaces to avoid runtime errors. As a back end developer I know the irritation of being blamed for a broken service, only to learn that the service was not properly invoked. API documentation should relieve this pain, but keeping it in sync with the code is an annoyance. And that's why it's a best practice to keep documentation with the code. The Open API Specification is a standard for documenting, consuming, and visually interfacing with machines. Swagger is a tool that implements the Open API Specification. Springdoc-openapi is a library that includes Swagger to dynamically generate Spring Boot API documentation. Let's add the springdoc dependency to our application and see what happens. And the version that this recording will be using is 1.4.5. So this is the base Open API, that's UI specification. Since we are using REST repositories, there's actually a separate…

Contents