Hands-On Microservices with Spring Boot and Spring Cloud

Adding textual descriptions of the API to the property file 

Finally, we need to add the textual descriptions of the API to the property file, application.yml. Here, we have @Value annotations, which look as follows:

@Value("${api.common.version}") String apiVersion;

For each @Value annotation, we need to specify a corresponding property in the YAML file; for example:

api:  common:    version: 1.0.0

In the same way, we have Swagger annotations, which look as follows:

@ApiOperation(value = "${api.product-composite.get-composite-product.description}")

These expect a corresponding property in the YAML file; for example:

api:  product-composite:    get-composite-product:      description: Returns a composite view of the specified product id

If you want to ...