A place to play around with OpenRPC.
This is a tool for editing, validating and previewing OpenRPC documents.
What is it?
This is meant to be an all-in-one developer portal for OpenRPC documents. It includes an editor and a live-preview of the documentation.
This helps developers visualize the OpenRPC and iterate very quickly on creating [OpenRPC documents]https://spec.open-rpc.org/#openrpc-document) via the built in editor tooling.
CTRL + SPACE- auto complete (TAB or ENTER to complete)
CTRL + N/CTRL + P- down/up a line (also works as up/down in autocomplete)
ALT + SHIFT + F- format document
CMD + K + BACKSPACE- reset to empty schema
CMD + K + I- pop up tooltip under cursor
CMD + K + V- toggle vim mode
CMD + K + R- replace meta schema
Configuration via Query String Parameters
The query string parameters can be used to configure the playground in different ways.
uiSchema is used for UI layer configuration. here is its interface:
schemaUrl - fetch schema by URL and display it as the content of the playground on startup.
schema - JSON String used to display it as the content of the playground on startup.
- set splitView to false
- hide appbar input bar
- provide custom name and logo
Resources and Inspirations
- Swagger Editor
- Marvel Interactive Documentation
- Algolia interactive documentation
- StackEdit in browser markdown editor
- Stripe API Docs
- Monaco Editor
This project was bootstrapped with Create React App.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
npm run build
Builds the app for production to the
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.