MicroProfile OpenAPI—Code First

Fri, 01 Dec 2023 00:00:00 +0000

You're given the task of writing a microservice AND providing a documentation in OpenAPI format. You already know that there are two main approaches:

code-first : write the code, using OpenAPI annotations, and then generate the OpenAPI document
design-first : write the OpenAPI document (a.k.a. the openapi.yaml file) and then generate the code

This article reviews the code-first approach, the design-first approach will follow in a second article at a later time.

Swagger on Pesches Schlauch

MicroProfile OpenAPI—Code First