types

package

v0.0.0-...-4799e85 Latest Latest Go to latest Published: Jun 7, 2021 License: BSD-2-Clause Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	// HTTPRequest defines an HTTP request
	HTTPRequest = iota

	// HTTPResponse defines an HTTP response
	HTTPResponse
)

This section is empty.

func AllTypes(apiDef *raml.APIDefinition, pkgName string) map[string]TypeTask

AllTypes returns all TypeTask that need to be generated by the code generator

func PascalCaseTypeName(tip TypeInBody) string

PascalCaseTypeName generates pascalcase type name from snackcase method name

type Endpoint struct {
	Addr     string // complete endpoint address
	Method   *raml.Method
	Resource *raml.Resource
	Verb     string
}

Endpoint represents an endpoint defined in the RAML specs

func (ep Endpoint) ResourceName() string

ResourceName returns resource name of an endpoint

type TypeInBody struct {
	Properties  map[string]interface{}
	Description string
	Endpoint    *Endpoint
	ReqResp     int
	RespCode    raml.HTTPCode
}

TypeInBody represents a Type that defined inline in the body

func (tib *TypeInBody) Body() raml.Bodies

Body returns raml.Bodies from TypeInBody object

type TypeTask struct {
	Type interface{}
	Name string
	Pkg  string
}

TypeTask defines a type generation task