gorestful

Documentation

Index

• type Client
  • func NewClient(apiDef *raml.APIDefinition, ...) (Client, error)
  • func (gc Client) Generate() error
• type ClientService
  • func (cs ClientService) Imports() []string
  • func (cs ClientService) NeedImportJSON() bool
• type Server
  • func NewServer(kind string, apiDef *raml.APIDefinition, ...) *Server
  • func (gs *Server) APIDocsDir() string
  • func (gs *Server) Generate() error
  • func (gs Server) RouteImports() []string
  • func (gs Server) ShowAPIDocsAndIndex() bool
  • func (gs Server) Title() string

Types

type Client

type Client struct {
	Name    string
	BaseURI string
	Kind    string

	PackageName    string
	RootImportPath string
	Services       map[string]*ClientService
	TargetDir      string
	// contains filtered or unexported fields
}

Client represents a Golang client

func NewClient

func NewClient(apiDef *raml.APIDefinition, kind, packageName, rootImportPath, targetDir string,
	libsRootURLs []string) (Client, error)

NewClient creates a new Golang client

func (Client) Generate

func (gc Client) Generate() error

Generate generates all Go client files

type ClientService

type ClientService struct {
	resource.ClientService
	PackageName string
	BaseURI     string
	NewParams   []string
	Methods     []clientMethod
}

ClientService represents a root endpoint of an API

func (ClientService) Imports

func (cs ClientService) Imports() []string

func (ClientService) NeedImportJSON

func (cs ClientService) NeedImportJSON() bool

NeedImportJSON returns true if this service need to import encoding/json

type Server

type Server struct {
	ResourcesDef []*goResource
	PackageName  string // Name of the package this server resides in

	RootImportPath string
	TargetDir      string // root directory of the generated code
	// contains filtered or unexported fields
}

Server represents a Go server

func NewServer

func NewServer(kind string, apiDef *raml.APIDefinition, packageName, apiDocsDir, rootImportPath string,
	withMain bool, targetDir string, libsRootURLs []string) *Server

NewServer creates a new Golang server

func (*Server) APIDocsDir

func (gs *Server) APIDocsDir() string

APIDocsDir implements codegen.Server.APIDocsDir interface

func (*Server) Generate

func (gs *Server) Generate() error

Generate implements codegen.Server.Generate interface

func (Server) RouteImports

func (gs Server) RouteImports() []string

RouteImports returns all resources routes

func (Server) ShowAPIDocsAndIndex

func (gs Server) ShowAPIDocsAndIndex() bool

ShowAPIDocsAndIndex returns if show api docs and index

func (Server) Title

func (gs Server) Title() string

Title returns title of this server