nim

Documentation

Index

• type Client
  • func NewClient(apiDef *raml.APIDefinition, dir string) Client
  • func (c *Client) Generate() error
• type Server
  • func NewServer(apiDef *raml.APIDefinition, apiDocsDir, dir string) *Server
  • func (s *Server) APIDocsDir() string
  • func (s *Server) Generate() error
  • func (s *Server) Imports() []string

Types

type Client

type Client struct {
	APIDef *raml.APIDefinition
	Dir    string
}

Client represents a Nim client

func NewClient

func NewClient(apiDef *raml.APIDefinition, dir string) Client

NewClient creates a new Nim client

func (*Client) Generate

func (c *Client) Generate() error

Generate generates all Nim client files

type Server

type Server struct {
	APIDef *raml.APIDefinition
	Dir    string
	Title  string

	Resources []resource
	// contains filtered or unexported fields
}

Server represents a Nim server

func NewServer

func NewServer(apiDef *raml.APIDefinition, apiDocsDir, dir string) *Server

NewServer creates a new Nim server

func (*Server) APIDocsDir

func (s *Server) APIDocsDir() string

APIDocsDir implements generator.Server.APIDocsDir interface

func (*Server) Generate

func (s *Server) Generate() error

Generate implements generator.Server.Generate interface

func (*Server) Imports

func (s *Server) Imports() []string

Imports returns array of modules that need to be imported by server's main file