Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

How to publish REST Services as Open API 3 specification

When you want to publish your REST Services also using Open API 3 specification standard then this can be done very simple. Only a small amount of additional information inside the UML model is required and then JEAF Generator can generate a complete Open API 3 specification of your services.

...

Final step is to also connect your REST services with the specification. To do so you need to define a dependency between your Open API Specification and your REST service.

How to modularize Open API Specifications

As soon as you will start to work with Open API on a more complex scenario you will find out that the YAML files will become rather big and confusing. Of course you still have your UML model where you have a way better overview. However also from the life cycle perspective it might be a good idea to split a large specification into smaller independent pieces.

...