Skip to content

[FAC-WEB-02] Generate API Types and Zod Schemas from OpenAPI using Kubb #3

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.

Sign up for GitHub

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

Merged
ayacoders merged 5 commits into from
Feb 25, 2026
Merged

[FAC-WEB-02] Generate API Types and Zod Schemas from OpenAPI using Kubb #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f69461
feat: added kubb for ts types generation, added types
ayacoders Feb 22, 2026
0d71eb9
fix: installed prettier for formatting after kubb generation
ayacoders Feb 22, 2026
938d950
fix: generate api.ts from yaml for client paths
ayacoders Feb 22, 2026
884d709
fix: reverted script for generating schema and adjusted kubb config
ayacoders Feb 22, 2026
0e7767f
chore: file cleanup
ayacoders Feb 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
440 changes: 0 additions & 440 deletions app/schema/index.d.ts
View file
Open in desktop

This file was deleted.

999 changes: 976 additions & 23 deletions bun.lock
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 28 additions & 0 deletions kubb.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { defineConfig } from '@kubb/core'
import { pluginOas } from '@kubb/plugin-oas'
import { pluginTs } from '@kubb/plugin-ts'
import { pluginZod } from '@kubb/plugin-zod'

export default defineConfig({
root: '.',
input: {
path: 'https://raw.githubusercontent.com/CtrlAltElite-Devs/faculytics-contracts/main/develop/openapi.yaml',
},
output: {
path: './types/kubb/gen',
clean: true,
},
plugins: [
pluginOas(),
pluginTs({
output: {
path: 'models',
},
}),
pluginZod({
output: {
path: 'zod',
},
}),
],
})
2 changes: 1 addition & 1 deletion lib/api-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import createFetchClient from "openapi-fetch";
import createClient from "openapi-react-query";
import type { paths } from "@/app/schema/index";
import type { paths } from "../schema/index.d.ts";

export const fetchClient = createFetchClient<paths>({
baseUrl: process.env.NEXT_PUBLIC_BACKEND_URL,
Expand Down
9 changes: 8 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"build": "next build",
"start": "next start",
"lint": "eslint",
"generate:api": "openapi-typescript https://raw.githubusercontent.com/CtrlAltElite-Devs/faculytics-contracts/refs/heads/main/develop/openapi.json -o ./app/schema/index.d.ts"
"generate:api": "openapi-typescript https://raw.githubusercontent.com/CtrlAltElite-Devs/faculytics-contracts/refs/heads/main/develop/openapi.json -o ./schema/index.d.ts"
},
"dependencies": {
"@tanstack/react-query": "^5.90.21",
Expand All @@ -23,13 +23,20 @@
"tailwind-merge": "^3.4.1"
},
"devDependencies": {
"@kubb/agent": "^4.27.1",
"@kubb/cli": "^4.27.1",
"@kubb/core": "^4.27.1",
"@kubb/plugin-oas": "^4.27.1",
"@kubb/plugin-ts": "^4.27.1",
"@kubb/plugin-zod": "^4.27.1",
"@tailwindcss/postcss": "^4",
"@types/node": "^20",
"@types/react": "^19",
"@types/react-dom": "^19",
"eslint": "^9",
"eslint-config-next": "16.1.6",
"openapi-typescript": "^7.13.0",
"prettier": "^3.8.1",
"shadcn": "^3.8.5",
"tailwindcss": "^4",
"tw-animate-css": "^1.4.0",
Expand Down
Loading