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] Client OpenApi generation #619

Open
2 tasks done
langehm opened this issue Dec 4, 2024 · 1 comment
Open
2 tasks done

[Feature] Client OpenApi generation #619

langehm opened this issue Dec 4, 2024 · 1 comment
Labels
Priority: Medium The issue contains work with medium priority. Type: Feature The issue is an feature

Comments

@langehm
Copy link
Contributor

langehm commented Dec 4, 2024

Relevant template

refarch-frontend, refarch-webcomponent

Problem description (optional)

Currently, there is no automated mechanism for generating client-side code based on the existing OpenAPI specification. This leads to manual efforts when updating API clients, which is both time-consuming and error-prone.

Desired solution

Introduce a process for automatically generating client-side code using the existing OpenAPI specification. The generated code should be compatible with VueJS and typescript used on the client side.
Therefore the openapi-generator-cli should be used as a dependency. Wether to use the standard fetch or the axios library can be discused (maybe the fetch library is enough - this reduces the amount of dependencies in general).

The process should be integrated into the build pipeline or provide a script for manual invocation.

Considered alternatives (optional)

There should be no manual way - this should be standardized!

Additional context (optional)

The spezification needs to be generated in some way. An open issue already exists for swagger documentation of the api - maybe there could be some kind of extension to also generate the api-specification (yaml).

No duplicate

  • I confirm that this issue is not a duplicate

Code of Conduct

  • I agree to follow this project's Code of Conduct
@langehm
Copy link
Contributor Author

langehm commented Dec 5, 2024

Should we reintroduce the shared folder for the openapi description? This should not be placed inside the backend folder as this name can change!

@devtobi devtobi added the Priority: Medium The issue contains work with medium priority. label Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Medium The issue contains work with medium priority. Type: Feature The issue is an feature
Projects
Development

No branches or pull requests

2 participants