O'Reilly logo

Hands-On Enterprise Java Microservices with Eclipse MicroProfile by Scott Stark, Antoine Sabot-Durand, Pavol Loffay, Jeff Mesnil, Heiko W. Rupp, Cesar Saavedra

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Generating the OpenAPI document

As already described, the MicroProfile OpenAPI specification requires that an OpenAPI document be generated from a combination of three sources.

You then have a number of choices:

  • Extend the OpenAPI document generated by the JAX-RS annotations using the MicroProfile OpenAPI annotations.
  • Leverage the initial output from /openapi, which you can use as a reference to start documenting your APIs. In this case, you can write static OpenAPI files (described in a later section in this chapter) before any code is written, which is a usual approach adopted by organizations to lock-in the contract of the API, that is, it is an API-first development practice.
  • Bootstrap or complete the OpenAPI model tree by coding ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required