Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create short Helidon guide describing how to use OpenAPITools generator for Helidon #4018

Closed
tjquinno opened this issue Mar 25, 2022 · 4 comments
Assignees
Labels
2.x Issues for 2.x version branch 3.x Issues for 3.x version branch open-api open-api-tools Tracking issues in OpenAPITools generator project

Comments

@tjquinno
Copy link
Member

Environment Details

  • Helidon Version: 2.x, 3.x
  • Helidon SE or Helidon MP MP
  • JDK version:
  • OS:
  • Docker version (if applicable):

Problem Description

Today, users can use the OpenAPITools generator to create Helidon MP server code and MicroProfile REST client code.
We have no documentation on the Helidon site explaining how to do this.

This issue represents creating a short guide which summarizes the support in the tool for Helidon and gives detailed instructions and examples (command line, the tool's maven plug-in, etc.) for using the tool to generated or update Helidon-friendly code.

@barchetta
Copy link
Member

This should include an example.

@tjquinno
Copy link
Member Author

tjquinno commented Apr 8, 2022

What sort of example are you thinking about?

I was thinking that the guide would show:

  • using the generator command line to create a new Maven project and/or regenerate code into an existing project
  • using the generator's Maven plug-in in the project pom.xml to generate/regenerate code

The guide would show how to extend generated classes or implement generated interfaces to provide the business logic and how regenerating code preserves those.

Were you thinking of adding a separate example generated project as a whole in the Helidon examples area?

I can see that this would be helpful for users. For simplicity I think we'll want the example pom.xml to invoke the Maven plug-in for the tool to generate code (rather than using the tool's command line to create the project). I don't think we want to get into having our build generate the code and then check the generated code into our repo.

That means that one contrast between this example and our other ones would be that this one's code in our repo will not be complete in the sense that the generated code won't be there. Of course, once a user builds the project and triggers the plug-in, the project becomes complete.

@barchetta
Copy link
Member

That sounds good. I was thinking it could follow the pattern that Keith uses in one of his projects. He has a project with spec, client and server modules. Maven plugin is used to generate client and server code (use base interface for generated code with business logic in implementing class). You can run the client code to communicate with the server.

@tvallin tvallin self-assigned this Apr 13, 2022
@barchetta
Copy link
Member

Covered by new Epic for Helidon Specific generator. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x Issues for 2.x version branch 3.x Issues for 3.x version branch open-api open-api-tools Tracking issues in OpenAPITools generator project
Projects
None yet
Development

No branches or pull requests

3 participants