README.md

WebRPC Schema

WebRPC is a design/schema driven approach to writing backend servers, with fully-generated client libraries. Write your schema, and it will generate strongly-typed bindings between your server and client. The type system is described below.

Some example webrpc schemas:

• from the _examples/, here is a schema in RIDL or in JSON
• ..find more in ./_examples

Type system

Basics

• byte (aka uint8)
• bool
• any
• null

Integers

• uint8

• uint16

• uint32

• uint64

• int8

• int16

• int32

• int64

Floats

• float32
• float64

Strings

• string

Timestamps (date/time)

• timestamp - for date/time

Lists

• form: []<type>
• ie.
  • []string
  • []uint8
  • [][]string
  • ..

Map

• form: map<key,value>
• ie.
  • map<string,any>
  • map<string,map<string,any>>
  • map<string,[]uint8>
  • map<int64,[]string>
  • map<string,User> - where User is a struct type defined in schema

Enums

• enum, see examples

Binary (future / v2)

• blob aka.. []byte
  • TODO: https://github.com/PsychoLlama/bin-json might have some ideas for us

Structs aka Objects / Messages

• struct or object
  • think of it just as a Javascript object or JSON object

Some notes on structs

• fields of an object can be optional
• fields of an object are by default required, unless made optional
• fields of an object always return default values by default, ie. default of int is 0, string is "", etc. (like in Go)
  • otherwise someone should make it optional which will have it be nullable