Eclipse MicroProfile Open Doc ( Open API + JavaDoc + … )
This MicroProfile specification aims at providing a implementation for the OpenAPI v3 specification using JavaDoc’s Doclet API that all application developers can use to expose their API documentation.
On top, it also aims to compliment MicroProfile documentation for component which are not covered under OpenAPI (only REST ) such as messaging and streams.
Further it can enhanced to cover other cloud native component such as lamda function as well.
-
The spec APIs are composed of annotations, models, and programming interfaces.
-
The spec documentation outlines the rules and boundaries of the spec.
-
To chat or ask questions about the spec, join the discussion on Gitter:
-
For announcements, visit the MicroProfile Google Group.
-
Extended examples that supplement the spec can be found here.
-
Eclipse release information and further logistics about the project can be found here.
Contributing
Do you want to contribute to this project? Find out how you can help here.