Skip to content

feat(openapi)!: spec generator rewrite and support multiple schema#61

Merged
dinwwwh merged 6 commits into
mainfrom
feat/openapi-generator-multiple-schema-support
Dec 28, 2024
Merged

feat(openapi)!: spec generator rewrite and support multiple schema#61
dinwwwh merged 6 commits into
mainfrom
feat/openapi-generator-multiple-schema-support

Conversation

@dinwwwh
Copy link
Copy Markdown
Member

@dinwwwh dinwwwh commented Dec 28, 2024

🚨 Breaking Changes Alert 🚨

The OpenAPI Spec Generator have been rewritten! Please refer to the updated documentation for details: Documentation. With this change, open opportunity to support multiple schema for generate OpenAI specs.

import { OpenAPIGenerator } from '@orpc/openapi'
import { ZodToJsonSchemaConverter } from '@orpc/zod'
import { router } from 'examples/server'
import { contract } from 'examples/contract'

const openAPIGenerator = new OpenAPIGenerator({
  schemaConverters: [
    new ZodToJsonSchemaConverter(),
  ],
})

const spec = await openAPIGenerator.generate(contract /* or router */, {
    info: {
        title: 'My App',
        version: '0.0.0',
    },
})

console.log(JSON.stringify(spec, null, 2))

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Dec 28, 2024

Open in Stackblitz

More templates

@orpc/client

npm i https://pkg.pr.new/@orpc/client@61

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@61

@orpc/next

npm i https://pkg.pr.new/@orpc/next@61

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@61

@orpc/react

npm i https://pkg.pr.new/@orpc/react@61

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@61

@orpc/server

npm i https://pkg.pr.new/@orpc/server@61

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@61

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@61

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@61

commit: e8b8100

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying orpc with  Cloudflare Pages  Cloudflare Pages

Latest commit: e8b8100
Status: ✅  Deploy successful!
Preview URL: https://f3c8c01c.orpc-1qh.pages.dev
Branch Preview URL: https://feat-openapi-generator-multi.orpc-1qh.pages.dev

View logs

@dinwwwh dinwwwh merged commit d42488d into main Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant