XMLWordPrintableJSON

    Details

      Description

      We would like to write an example for MicroProfile OpenApi.

      Here is the MicroProfile specification url:

      https://download.eclipse.org/microprofile/microprofile-open-api-1.0.1/microprofile-openapi-spec.html

      Fork / clone the TomEE project from here:

      https://github.com/apache/tomee

      Example name should be mp-openapi, following the standard already in the project.

      All the examples are in:

      https://github.com/apache/tomee/tree/master/examples

      See this example of Microprofile Metrics for reference:

      https://github.com/apache/tomee/tree/master/examples/mp-metrics-counted

       

      What you have to do is:

      1 - Create a JAX-RS endpoint with some methods (Using the same domain from metrics - WeatherService would be good)

      2 - Annotate with OpenApi annotations

      3 - Write a test to assert the response in JSON and YAML

      4 - Make sure all the tests pass

      After that submit a PR and we'll review it.

        Attachments

          Activity

            People

            • Assignee:
              ivanjunckes Ivan Junckes Filho
              Reporter:
              ivanjunckes Ivan Junckes Filho
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 10m
                10m