golang

Documentation

Index

• type Error
  • func (e Error) StringCode() string
• type Generator
  • func NewClient(schema smd.Schema, settings Settings) *Generator
  • func (g *Generator) Generate() ([]byte, error)
• type Method
  • func (m Method) CommentDescription() string
  • func (m Method) HasErrors() bool
  • func (m Method) HasResult() bool
• type Model
• type Namespace
• type Schema
  • func NewSchema(schema smd.Schema) Schema
  • func (s Schema) MethodByName(namespace, methodName string) Method
  • func (s Schema) Models() (res []Model)
  • func (s Schema) NamespaceByName(namespace string) Namespace
  • func (s Schema) NamespaceMethodNames(namespace string) (res []string)
  • func (s Schema) NamespaceNames() (res []string)
• type Settings
• type Value
  • func (v Value) CommentDescription() string
  • func (v *Value) GoType() string
  • func (v Value) LocalModelName() string

Types

type Error

type Error struct {
	Code    int
	Message string
}

func (Error) StringCode

func (e Error) StringCode() string

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator main package structure

func NewClient

func NewClient(schema smd.Schema, settings Settings) *Generator

NewClient create Generator from zenrpc/v2 SMD.

func (*Generator) Generate

func (g *Generator) Generate() ([]byte, error)

Generate returns generated Go client.

type Method

type Method struct {
	Name string

	// Params contains all method arguments
	Params []Value

	// RPC requires single one return value
	Returns *Value

	// Models contains all models which linked from Params or Return values by ModelName
	Models []Model

	// Description describes what the method does
	Description string

	// Typed errors
	Errors []Error
}

func (Method) CommentDescription

func (m Method) CommentDescription() string

CommentDescription add to head of all lines two slashes

func (Method) HasErrors

func (m Method) HasErrors() bool

func (Method) HasResult

func (m Method) HasResult() bool

type Model

type Model struct {
	Name        string
	Description string

	// IsParamModel indicate model is top-level method model
	IsParamModel bool
	// ParamName from smd method param name
	ParamName string
	// IsReturnModel indicate is return model
	IsReturnModel bool

	Fields []Value
}

type Namespace

type Namespace struct {
	Name    string
	Methods []Method
}

type Schema

type Schema struct {
	gen.GeneratorData
	Package    string
	Namespaces []Namespace
}

func NewSchema

func NewSchema(schema smd.Schema) Schema

NewSchema convert smd.Schema to Schema

func (Schema) MethodByName

func (s Schema) MethodByName(namespace, methodName string) Method

func (Schema) Models

func (s Schema) Models() (res []Model)

Models return all models from all methods

func (Schema) NamespaceByName

func (s Schema) NamespaceByName(namespace string) Namespace

func (Schema) NamespaceMethodNames

func (s Schema) NamespaceMethodNames(namespace string) (res []string)

NamespaceMethodNames return all methodNames by namespace name.

func (Schema) NamespaceNames

func (s Schema) NamespaceNames() (res []string)

NamespaceNames return all namespace names.

type Settings

type Settings struct {
	Package string
}

type Value

type Value struct {
	Name        string
	Type        string
	Optional    bool
	Description string

	ArrayItemType string

	ModelName string
}

func (Value) CommentDescription

func (v Value) CommentDescription() string

CommentDescription add to head of all lines two slashes

func (*Value) GoType

func (v *Value) GoType() string

GoType convert Value jsType to golang type

func (Value) LocalModelName

func (v Value) LocalModelName() string

LocalModelName rename external packages model names: pkg.Model -> PkgModel