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

Add OpenRPC support #4844

Closed
shanejonas opened this issue May 25, 2020 · 1 comment
Closed

Add OpenRPC support #4844

shanejonas opened this issue May 25, 2020 · 1 comment
Labels
needs triage This issue has not been looked into type: enhancement 🐺

Comments

@shanejonas
Copy link

shanejonas commented May 25, 2020

Feature Request

Describe the solution you'd like

I think this project could benefit from integration with OpenRPC which provides a base foundation for service discovery and tooling such as documentation/client generation/mock server for JSON-RPC akin to OpenAPI/Swagger.

Here is an example of the OpenRPC playground, it gets the OpenRPC Document via calling the rpc.discover method:

https://playground.open-rpc.org/?url=https://mock.open-rpc.org/petstore-1.0.0

and just the bare inspector:
https://inspector.open-rpc.org/?url=https://mock.open-rpc.org/petstore-1.0.0

Let me know how I can help.

Teachability, Documentation, Adoption, Migration Strategy

image
image

What is the motivation / use case for changing the behavior?

Read more about the advantages of OpenRPC vs Swagger.

@shanejonas shanejonas added needs triage This issue has not been looked into type: enhancement 🐺 labels May 25, 2020
@kamilmysliwiec
Copy link
Member

We don't plan to release a dedicated package for the OpenRPC. We encourage anyone who is interested in contributing to the ecosystem to give it a shot and maybe release as a community package. For reflecting & generating data models, the @nestjs/swagger can be used (at least as a reference implementation)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage This issue has not been looked into type: enhancement 🐺
Projects
None yet
Development

No branches or pull requests

2 participants