Documenting the service APIs

API documentation is especially important in a microservices architecture for intuitive access to the API information, since an application can have multiple microservices and each microservice runs several API endpoints. OpenAPI is the de facto standard for any web services documentation. The Swagger framework, an implementation of OpenAPI, is integrated easily with a Micronaut microservice. We can easily document all our service endpoints using Swagger. In the following sections, we will explore how we can integrate Swagger into the pet-owner microservice.

Using Swagger to document the pet-owner service endpoints

To start using Swagger in the pet-owner microservice, we first need to import the following dependency into the pom.xml project:

<!-- Swagger -->
<dependency>
  <groupId>io.swagger.core.v3</groupId>
  <artifactId>swagger-annotations</artifactId>
  <version>${swagger...