https://github.com/apache/geronimo-openapi

Apache Geronimo Microprofile OpenAPI Implementation
https://github.com/apache/geronimo-openapi

geronimo http java javaee network-server web-framework

Last synced: 10 months ago
JSON representation

Apache Geronimo Microprofile OpenAPI Implementation

• Host: GitHub
• URL: https://github.com/apache/geronimo-openapi
• Owner: apache
• Created: 2018-06-21T06:56:06.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-11-15T23:31:23.000Z (about 3 years ago)
• Last Synced: 2025-04-03T04:16:55.896Z (10 months ago)
• Topics: geronimo, http, java, javaee, network-server, web-framework
• Language: Java
• Homepage: https://geronimo.apache.org/
• Size: 335 KB
• Stars: 11
• Watchers: 15
• Forks: 16
• Open Issues: 2
• Metadata Files:
  • Readme: README.adoc

Awesome Lists containing this project

README

          
= Geronimo Microprofile OpenAPI

== Implementation

=== Artifact

[source,xml]

----

  org.apache.geronimo

  geronimo-openapi

  ${openapi.version}

----

=== Dependencies

1. JAX-RS+Servlet

2. CDI (optional if used as a library)

3. JSONB (for JSON support)

4. Jackson+YAML extension (for YAML support)

== Maven Plugin

You can define the maven plugin to generate at build time the `openapi.json` file.

Then the runtime is able to load it directly and merge it with the current runtime.

The big advantage is to be able to use it without the runtime for documentation purposes.

Here is how to define it:

[source,xml]

----

  org.apache.geronimo

  geronimo-openapi-maven-plugin

  ${openapi.version}

  

    

      generate-openapi.json

      

        openapi.json

      

      

        com.test.MyApp

        

          com.test.SomeEndpoint

          com.test.SomeOtherEndpoint

        

        

          1

          My Title

          Bla Bla

        

      

    

  

----