/generator

Multi-Component & Multi-Language Generators for OpenRPC

Primary LanguageTypeScript

OpenRPC Generator

CircleCI branch Dependabot status npm GitHub release GitHub commits since latest release

A Generator tool for open-rpc APIs.

Need help or have a question? Join us on Discord!

Features:

  • Built in components for:
    • Clients
    • Server
    • Documentation
  • Easy to create new components

Usage

The generator CLI has a generate command which takes a config to run. The config specifies what components you want to make, as well as the configuration for each component.

Using the CLI's init command, you can walk though an interactive config builder.

Quick start

npm install -g @open-rpc/generator

open-rpc-generator init
open-rpc-generator generate -c open-rpc-generator-config.json

Generating an individual component

$ open-rpc-generator-client generate
  -t client
  -l typescript
  -n petstoreClientTs
  -d https://raw.githubusercontent.com/open-rpc/examples/master/service-descriptions/petstore-openrpc.json
  -o ./generated

Resources