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

[Feature][LFX] Auto-generate the TypeScript and Java languages API SDK #5428

Open
barnettZQG opened this issue Feb 6, 2023 · 7 comments
Open
Labels
summber-of-code and lfx the issue for lfx and google/alibaba summer of code

Comments

@barnettZQG
Copy link
Collaborator

barnettZQG commented Feb 6, 2023

Is your feature request related to a problem? Please describe.

The KubeVela API server follows the Open API schema. It could auto-generate the swagger configs via CLI in VelaUX repo.

make build-swagger

The swagger config file: https://github.com/kubevela/velaux/blob/main/docs/apidoc/swagger.json

VelaUX or other projects need to call these APIs. They must write the model code and the request API code. We should provide the SDK to help them start faster.

OpenAPI generator could help to generate most codes, but we also need to handle some special cases. Such as:

  1. The component, trait, workflow step, and policy properties are dynamic. They all define with CUE, [Feature] [LFX] Support auto generation of multiple languages SDK from CUE #5365 plan to auto-generate the struct. The API SDK should include them.
  2. Automatically handles the user authentication process, including automatically refreshing tokens.
  3. The API definition may be incomplete accuracy, we should check it to generate high-quality code.
@wonderflow wonderflow added the summber-of-code and lfx the issue for lfx and google/alibaba summer of code label Feb 8, 2023
@money8203
Copy link

Hey @barnettZQG I am a junior dev with basic understandings of web development, Unity3D, API's and I'm willing to learn new skills and apply them to solve real world problems along the way. So will this project aligns with my skills and enthusiasm ?

@barnettZQG
Copy link
Collaborator Author

@money8203 Enthusiasm is very important. I am happy to help you work on this project as well. You could contact me on the Slack channel.

@barnettZQG
Copy link
Collaborator Author

#5536 This is a related issue.

@chivalryq chivalryq changed the title [Feature][GSOC] Auto-generate the TypeScript and Java languages API SDK [Feature][LFX] Auto-generate the TypeScript and Java languages API SDK May 11, 2023
@shashankiitbhu
Copy link

Hi @barnettZQG I am really interested in this project and would like to contribute to it, I have already set up the project. what else I can do to understand the project better? I am Interested in working on this under LFX Mentorship

@achiverram28
Copy link

Hi @barnettZQG I am a really enthusiastic cloud native , kubernetes and back-end enthusiast and I also have applied as a mentee in the LFX mentorship program for your project . I would like to learn and contribute my best to this project. Can you guide me in understanding this project better

@Nupoor10
Copy link

Hii @barnettZQG I am an undergrad student and I am eager to work on this project under the lfx mentorship. I am a full stack developer with a love of learning new technologies and constantly improving my work. I am setting this project up and I hope to make a meaningful contribution!

@SyedAhkam
Copy link

SyedAhkam commented May 18, 2023

@barnettZQG I'm confident that I can complete this task if you provide me with the necessary direction. I have experience building API wrappers over Rest API's.

Would love to contribute under LFX mentorship!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
summber-of-code and lfx the issue for lfx and google/alibaba summer of code
Projects
None yet
Development

No branches or pull requests

7 participants