Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.82 KB

README.md

File metadata and controls

41 lines (29 loc) · 1.82 KB
Raw

OpenAPI And Vert.x Bootstrap Archetype (Work In Progress)

Following a Contract-First API Development Approach can be daunting depending on the tools, languages, and frameworks you might like to use. This Maven Archetype is a quick-start for building a new OpenAPI driven application in Spring Boot.

Hacktoberfest Participants

If you would like to submit a pull against this repository and have it count toward Hacktoberfest, please be aware that this is what we are looking for:

  • Improvements to the archetype:
    • Better or more idomatic workflow (Subjective and at the discretion of our team to decide if wanted)
    • Fixes to spelling
    • Updated or improved tooling

In order to avoid wasting your time and ours, it is recommended that you submit an issue describing your contribution first.

Thank you! And happy hacking!!

Using This Archetype

mvn archetype:generate -DarchetypeGroupId=com.redhat.consulting \
                       -DarchetypeArtifactId=openapi-spring-archetype \
                       -DarchetypeVersion=1.0.3 \
                       -Dpackage=com.redhat.runtimes \
                       -DgroupId=com.redhat.runtimes.springboot \
                       -DartifactId=springboot-petstore \
                       -Dversion=0.0.1-SNAPSHOT \
                       -Dopenapi_app_contract_uri=https://petstore.swagger.io/v2/swagger.yaml \
                       -Dinteractive=false

Current Status

  • Able to generate a maven project
  • Integrates OpenAPI Generator via Maven Plugin
  • Generates JPA Entity classes from the OpenAPI contract
  • Creates interfaces for REST Controllers

Forthcoming Features

  • Add your idea to the GitHub issues!!!