commands

Documentation

Index

• Variables
• type CapnpCommand
  • func (command *CapnpCommand) Execute() error
• type ClientCommand
  • func (command *ClientCommand) Execute() error
• type DocsCommand
  • func (command *DocsCommand) Execute() error
• type PythonCapnp
  • func (command *PythonCapnp) Execute() error
• type ServerCommand
  • func (command *ServerCommand) Execute() error
• type SpecCommand
  • func (command *SpecCommand) Execute() error

Variables

var (
	// CommitHash represents the Git commit hash at built time
	CommitHash string
	// BuildDate represents the date when this tool was built
	BuildDate string
)

Types

type CapnpCommand

type CapnpCommand struct {
	Dir      string //target dir
	RAMLFile string //raml file
	Language string
	Package  string
}

CapnpCommand is executed to generate capnpm model from RAML specification

func (*CapnpCommand) Execute

func (command *CapnpCommand) Execute() error

Execute generates a client from a RAML specification

type ClientCommand

type ClientCommand struct {
	Language    string
	Dir         string //target dir
	RamlFile    string //raml file
	PackageName string //package name in the generated go source files
	ImportPath  string
	Kind        string

	// Root URL of the libraries.
	// Usefull if we want to use remote libraries.
	// Example:
	//   root url     = http://localhost.com/lib
	//   library file = http://localhost.com/lib/libraries/security.raml
	//	 the library file is going to treated the same as local : libraries/security.raml
	LibRootURLs string

	// If true, python client will unmarshall the response
	// Other languages already unmarshall the response
	PythonUnmarshallResponse bool
}

ClientCommand is executed to generate client from a RAML specification

func (*ClientCommand) Execute

func (command *ClientCommand) Execute() error

Execute generates a client from a RAML specification

type DocsCommand

type DocsCommand struct {
	Format     string
	OutputFile string //target dir
	RamlFile   string //raml file
}

ClientCommand is executed to generate client from a RAML specification

func (*DocsCommand) Execute

func (command *DocsCommand) Execute() error

Execute generates a client from a RAML specification

type PythonCapnp

type PythonCapnp struct {
	Dir      string //target dir
	RAMLFile string //raml file
}

PythonCapnp is executed to generate python class with capnp loader from RAML specification

func (*PythonCapnp) Execute

func (command *PythonCapnp) Execute() error

Execute generates a client from a RAML specification

type ServerCommand

type ServerCommand struct {
	Language         string // target language
	Kind             string
	Dir              string //target dir
	RamlFile         string //raml file
	PackageName      string //package name in the generated go source files
	NoMainGeneration bool   //do not generate a main.go file
	ImportPath       string // root import path of the code, such as : github.com/jumpscale/restapi
	NoAPIDocs        bool   // do not generate API Docs in /apidocs/ endpoint

	// Root URL of the libraries.
	// Usefull if we want to use remote libraries.
	// Example:
	//   root url     = http://localhost.com/lib
	//   library file = http://localhost.com/lib/libraries/security.raml
	//	 the library file is going to treated the same as local : libraries/security.raml
	LibRootURLs string
}

ServerCommand is executed to generate a go server from a RAML specification

func (*ServerCommand) Execute

func (command *ServerCommand) Execute() error

Execute generates a Go server from an RAML specification

type SpecCommand

type SpecCommand struct{}

SpecCommand is executed to generate a RAML specification from a go server

func (*SpecCommand) Execute

func (command *SpecCommand) Execute() error

Execute generates a RAML specification from a go server