OpenAPITools / OpenAPITools/openapi-generator
Can I contribute an XQuery RESTXQ server stub generator
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Hi there, in the XQuery language we have RESTXQ which is a bit like Java's JAX-RS annotations. I would be interested in contributing a server stub code generator for this.
If I sent a PR for this, would it be considered?
Can I also check if I understand correctly that I need to basically follow these steps:
-
Create a new generator class
XQueryRestXq1ServerCodegenin themodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/directory. -
Provide Mustache templates in a
src/main/resources/xquery-restxq1directory for models, API endpoints, and server stub code. -
Add the new generator to the list of supported server stubs.
-
Add tests/samples: build a minimal
petstore.yamlwith the cli using-g xquery-restxq1example and confirm generation works.
Contributor guide
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 with the generator classes in modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ and review how supported generators are registered. Then examine the proposed src/main/resources/xquery-restxq1 templates and the petstore.yaml CLI sample path. Done means the new xquery-restxq1 generator, model/API/server templates, registration, and generation test are accepted and working.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend-api-design, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100