generator

Documentation

Index

• Constants
• type APISchema
• type Article
• type Description
• type Field
• type Generator
  • func NewGenerator(schemaFile, tempaltesDir string) (*Generator, error)
  • func (g *Generator) Generate(outDir string) error
• type Method
• type Type
• type TypeMapping
  • func (t TypeMapping) ArrayType() TypeMapping
  • func (t TypeMapping) GoType() string
  • func (t TypeMapping) IsArray() bool
  • func (t TypeMapping) IsSimpleType() bool
  • func (t TypeMapping) SplitArray() string

Constants

const InputFile = "InputFile"

Types

type APISchema

type APISchema struct {
	Articles map[string]Article `json:"articles"`
	Methods  map[string]Method  `json:"methods"`
	Types    map[string]Type    `json:"types"`
	Version  string             `json:"version"`

	BuildInfo  map[string]interface{} `json:"build_info"`
	Changelogs map[string]interface{} `json:"changelogs"`
}

type Article

type Article struct {
	Description
	Title    string `json:"title"`
	Category string `json:"category"`
}

type Description

type Description struct {
	PlainText string `json:"plaintext"`
	Markdown  string `json:"markdown"`
	HTML      string `json:"html"`
}

type Field

type Field struct {
	Types       []TypeMapping `json:"types"`
	Description Description   `json:"description"`
	Required    bool          `json:"required"`
}

type Generator

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

func NewGenerator

func NewGenerator(schemaFile, tempaltesDir string) (*Generator, error)

func (*Generator) Generate

func (g *Generator) Generate(outDir string) error

type Method

type Method struct {
	Arguments map[string]Field `json:"arguments"`
	// null available
	Returns     *TypeMapping `json:"returns"`
	Description Description  `json:"description"`
	Category    string       `json:"category"`
}

type Type

type Type struct {
	Fields      map[string]Field `json:"fields"`
	Description Description      `json:"description"`
	Category    string           `json:"category"`
}

type TypeMapping

type TypeMapping string

func (TypeMapping) ArrayType

func (t TypeMapping) ArrayType() TypeMapping

func (TypeMapping) GoType

func (t TypeMapping) GoType() string

func (TypeMapping) IsArray

func (t TypeMapping) IsArray() bool

func (TypeMapping) IsSimpleType

func (t TypeMapping) IsSimpleType() bool

func (TypeMapping) SplitArray

func (t TypeMapping) SplitArray() string