Skip to content

[Feature] Client OpenApi generation #619

@langehm

Description

@langehm

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

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status

Open

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions