README.adoc

Eclipse MicroProfile OpenAPI

This MicroProfile specification aims at providing a unified Java API for the OpenAPI v3 specification, that all application developers can use to expose their API documentation.

• 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.

How to contribute

Do you want to contribute to this project? Here is what you can do:

• Fork the repository, make changes, then do a pull request.

  • Remember to sign your commits

  • Make sure you have signed the Eclipse Contributor Agreement

• Create or fix an issue.

• Join us on Gitter to discuss this project.

• Join our bi-weekly meeting every second Monday at 15h00 GMT.

  • Minutes and Agenda.

  • Meeting room.

• Join the discussions on the MicroProfile Google Group

• Contribute a blog post.

Also see the MicroProfile Contributing Guidelines on the Eclipse MicroProfile wiki page and the CONTRIBUTING page.