Auto generate zodios client from openapi spec #2
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
matejm
reviewed
May 29, 2024
| @@ -13,7 +13,8 @@ | |||
| "format:fix": "prettier --write --ignore-path .prettierignore .", | |||
| "test": "jest", | |||
| "test:watch": "jest --watch", | |||
| "i18n": "tsx ./scripts/validate-translations.ts" | |||
| "i18n": "tsx ./scripts/validate-translations.ts", | |||
| "gen-api": "infisical run --command 'openapi-zod-client \"$NEXT_PUBLIC_API_URL/docs/bundle.yml\" -o './src/zodios/inedx.ts' -t ./scripts/zodios-client-template.hbs' && prettier --write ./src/zodios/inedx.ts" | |||
There was a problem hiding this comment.
Suggested change
| "gen-api": "infisical run --command 'openapi-zod-client \"$NEXT_PUBLIC_API_URL/docs/bundle.yml\" -o './src/zodios/inedx.ts' -t ./scripts/zodios-client-template.hbs' && prettier --write ./src/zodios/inedx.ts" | |
| "gen-api": "infisical run --command 'openapi-zod-client \"$NEXT_PUBLIC_API_URL/docs/bundle.yml\" -o './src/zodios/index.ts' -t ./scripts/zodios-client-template.hbs' && prettier --write ./src/zodios/index.ts" |
matejm
reviewed
May 29, 2024
| @@ -69,6 +69,8 @@ Getting started with this Next.js template is straightforward. Follow these step | |||
| - [zod](https://zod.dev/) for form validation | |||
| - [Zodios](https://www.zodios.org/docs/client) for external API calls with validation | |||
| - Github Actions for lint, typecheck, localizations checks and tests. | |||
| - [openapi-zod-client](https://www.npmjs.com/package/openapi-zod-client) for generating API clients | |||
| - We include a handlebars template for generating the zodios client from the openapi spec. It can be used with `pnpm gen-api` command. | |||
There was a problem hiding this comment.
Suggested change
| - We include a handlebars template for generating the zodios client from the openapi spec. It can be used with `pnpm gen-api` command. | |
| - We include a handlebars template for generating the zodios client from the openapi spec. It can be used with `pnpm gen-api` command. | |
| - Adjust the `gen-api` command in [package.json](package.json) to fetch the OpenAPI `yaml` file from the correct URL. |
matejm
approved these changes
May 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR description 🔨
Added script and commands for generating a zodios client from open api spec.
See:
Author checklist ✅