golang

Documentation

Index

• func CreateFunctionString(s string) (ret string)
• func DefaultFuncMap() *template.FuncMap
• func IsHttpStatusCode(s string) bool
• func MustLoadGinServerTestConfig(configPath, openAPIPath string) config.Data
• func MustLoadGoClientTestConfig(configPath, openAPIPath string) config.Data
• func SanitiseName(s []string) string
• func SanitiseType(n tree.NodeTraverser) string
• func ToTitle(s string) (ret string)
• type Renderer
  • func (g *Renderer) Format(input []byte) ([]byte, error)
  • func (g *Renderer) GetOutputFilename(n tree.NodeTraverser) string
  • func (g *Renderer) GetTemplateFuncMap() *template.FuncMap
  • func (g *Renderer) RenderNode(parsedTemplate *template.Template, node tree.NodeTraverser) ([]byte, error)
  • func (g *Renderer) SetTemplateFuncMap(f *template.FuncMap)

Functions

func CreateFunctionString

func CreateFunctionString(s string) (ret string)

CreateFunctionString strips a string of any leading non-alphabetical chars, and all non-alphabetical and non-numerical characters that follow.

func DefaultFuncMap

func DefaultFuncMap() *template.FuncMap

DefaultFuncMap contains a function map with sensible defaults for go template rendering

func IsHttpStatusCode

func IsHttpStatusCode(s string) bool

func MustLoadGinServerTestConfig

func MustLoadGinServerTestConfig(configPath, openAPIPath string) config.Data

func MustLoadGoClientTestConfig

func MustLoadGoClientTestConfig(configPath, openAPIPath string) config.Data

func SanitiseName

func SanitiseName(s []string) string

SanitiseName should consume the result of an NodeTraverser's .GetName() function. It creates a string array that is compliant to go function name restrictions and joins the result before returning a single string.

func SanitiseType

func SanitiseType(n tree.NodeTraverser) string

SanitiseType sanitizes the prepares the contents of the Type field of a node for use by the renderer

func ToTitle

func ToTitle(s string) (ret string)

Types

type Renderer

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

func (*Renderer) Format

func (g *Renderer) Format(input []byte) ([]byte, error)

Format applies the same formatter in use in gofmt to a rendered template. This is the standard formatter for all go code.

func (*Renderer) GetOutputFilename

func (g *Renderer) GetOutputFilename(n tree.NodeTraverser) string

GetOutputFilename provides an appropriate filename for any rendered output based on the node provided.

func (*Renderer) GetTemplateFuncMap

func (g *Renderer) GetTemplateFuncMap() *template.FuncMap

func (*Renderer) RenderNode

func (g *Renderer) RenderNode(parsedTemplate *template.Template, node tree.NodeTraverser) ([]byte, error)

RenderNode writes the relevant information contained within an openapi node into the provided template and returns the result.

func (*Renderer) SetTemplateFuncMap

func (g *Renderer) SetTemplateFuncMap(f *template.FuncMap)