jsonmsg

Overview ¶

Package jsonmsg parses API specs. The resulting spec can be used to generate server/client source code in any supported language.

The jsonmsg implementation is based on https://github.com/jsonmsg/spec with the meta-schema https://github.com/jsonmsg/spec/blob/master/meta.json

Generators ¶

go: https://godoc.org/github.com/tfkhsr/jsonmsg/golang

Parse a spec:

schema := `
{
  "endpoints": {
    "http": "https://jsonmsg.github.io/v1",
    "websocket": "wss://jsonmsg.github.io/v1"
  },
  "messages": {
    "findUser": {
      "in": "#/definitions/userQuery",
      "outs": [
        "#/definitions/user",
        "#/definitions/error"
      ],
      "group": "user"
    }
  },
  "definitions": {
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": ["id", "name"]
    },
    "userQuery": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      },
      "required": ["id"]
    },
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        }
      },
    "required": ["message"]
    }
  }
}
`

// parse spec
spc, err := Parse(spec)
if err != nil {
	panic(err)
}

// spc now contains:
// spc.Messages["findUser"]        : *Message{...}
// spc.Definitions["user"]         : *jsonschema.Schema{...}