reactiverse / reactiverse/vertx-maven-plugin
Enhancement: Generate Stub Implementation From OpenAPI Spec
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 81
- Forks
- 12
- Avg merge
- 20h 19m
- Merged PRs (30d)
- 9
Description
Use Case:
You have an OpenAPI v3 API specification and would like to generate a Vert.x application skeleton from that Spec.
Ideally, the maven target would read and parse the YAML Spec, generate Service Proxy stubs for each top-level endpoint and method implementations for each VERB endpoint.
Then, aMainVerticlewould be created which sets up the ServiceBinder and binds the Service Proxy methods to the OpenAPI3Router endpoints.
Proposal:
Implement a new target
openapi-generatewhich can read the YAML and use Velocity (or other) templates to create the stubbed skeleton.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Maven plugin's existing targets and the proposed openapi-generate target, then trace how the YAML OpenAPI v3 specification would feed the proposed Velocity templates. Done means generating a Vert.x application skeleton with Service Proxy stubs, VERB method implementations, a MainVerticle, and ServiceBinder bindings for OpenAPI3Router endpoints.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api, build-system
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100