generated from it-at-m/oss-repository-en-template
-
Notifications
You must be signed in to change notification settings - Fork 7
✨ 619 feature client openapi generation #1050
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
Open
langehm
wants to merge
16
commits into
main
Choose a base branch
from
619-feature-client-openapi-generation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
da19eae
:heavy_plus_sign: added frontend open-api-generator
dfd08d2
:arrow_up: frontend open-api-generator
e1e4ab7
:wrench: added openapi-config for refarch-backend
e433908
:alien: generated first api-version
edbbec2
Merge branch 'refs/heads/main' into 619-feature-client-openapi-genera…
langehm c11dda5
updated openapi version
langehm 1c27764
updated openapi configuration - placeholder do not work inside the "g…
langehm 9b38c8a
regenerated openapi client with newer configuration
langehm a7db09d
:see_no_evil: included generated api-folders in the prettierignore
langehm f8fcada
repeated steps with webcomponent module
langehm 484a0ae
updated lock-files
langehm 658c25c
:see_no_evil: added generated folders to eslint-ignore
langehm 8a9c93b
removed unused file
langehm 97ec95b
updated version / options and regenerated code
langehm edd0d37
sorted packages alphabetically
langehm 3ba15ce
Merge branch 'main' into 619-feature-client-openapi-generation
langehm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,5 @@ | ||
| dist | ||
| node_modules | ||
| node_modules | ||
|
|
||
| # Ignore generated api-folders only | ||
| src/api/*/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,5 +43,5 @@ export default defineConfigWithVueTs( | |
| }, | ||
| }, | ||
| }, | ||
| globalIgnores(["dist", "target", "node_modules", "env.d.ts"]) | ||
| globalIgnores(["dist", "target", "node_modules", "env.d.ts", "src/api/*/**"]) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See previous comment |
||
| ); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json", | ||
| "spaces": 2, | ||
| "generator-cli": { | ||
| "version": "7.19.0", | ||
| "generators": { | ||
| "refarch-backend": { | ||
| "generatorName": "typescript-fetch", | ||
| "glob": "../refarch-backend/target/*.yaml", | ||
| "output": "#{cwd}/src/api/#{name}", | ||
| "additionalProperties": { | ||
| "supportsES6": true, | ||
| "enumPropertyNaming": "UPPERCASE" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There might be cases where we have custom hand written code in src/api so I suggest to change it to something like src/api/generated
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
custom hand written is inside of
/apias seperate files. Those are getting ignored.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah but what if you add custom subfolders in the API folder?
@simonhir @DanielOber What do you think about this?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My thought on this: We implemented code geneation for apis - used it.
Smaller api or api-request can still be written in separated files, larger apis should be generated from a specification.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For me personally, i would keep my generated APIs inside a
generatedfolder. So i would prefer to ignore everything insidesrc/api/generatedlike Tobi said.