Skip to content
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

bug: remove trpc-openapi as a sugested solution for exposing procedures as REST endpoints #1998

Open
thomasreichmann opened this issue Oct 19, 2024 · 0 comments

Comments

@thomasreichmann
Copy link

thomasreichmann commented Oct 19, 2024

Provide environment information

N/A

Describe the bug

In the trpc usage section of the docs, trpc-openapi is suggested as a community plugin to expose all trpc procedures as REST endpoints, but since the docs were created, the plugin has stopped being maintained and It doesn't seem like a consensus has been reached on which fork will succeed it.

### Exposing every procedure as a REST endpoint
If you want to expose every single procedure externally, checkout the community built plugin [trpc-openapi](https://github.com/jlalmes/trpc-openapi/tree/master). By providing some extra meta-data to your procedures, you can generate an OpenAPI compliant REST API from your tRPC router.

Reproduction repo

N/A

To reproduce

N/A

Additional information

I'd love to be able to use it in production, but since its maintainer is no longer supporting the project and has also not appointed someone to maintain it, nor specified which fork should act as the successor, maybe the t3 community could take the lead in maintaining a fork so that we could recommend it in the docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant