httpapi

Documentation

Index

• type Contract
• type Endpoint
  • func ParseEcho(pkg *packages.Package, absFilePath string) []Endpoint
• type Form
  • func (f Form) AsTypedValues() []TypedParam
  • func (f Form) IsZero() bool
• type TypedParam

Types

type Contract

type Contract struct {
	Name string

	InputBody analysis.Type

	// Return may be nil
	Return analysis.Type

	InputForm        Form
	InputQueryParams []TypedParam

	IsReturnBlob bool // Return is a []byte, interpreted as a file
	// contains filtered or unexported fields
}

Contract describes the expected and returned types for one endpoint.

type Endpoint

type Endpoint struct {
	Url      string
	Method   string
	Contract Contract
}

Endpoint describes one server endpoint

func ParseEcho

func ParseEcho(pkg *packages.Package, absFilePath string) []Endpoint

ParseEcho scans a file using the Echo framework.

type Form

type Form struct {
	File       string // empty means no file
	ValueNames []string
}

func (Form) AsTypedValues

func (f Form) AsTypedValues() []TypedParam

AsTypedValues returns the name of the form parameters with type String

func (Form) IsZero

func (f Form) IsZero() bool

type TypedParam

type TypedParam struct {
	Type *analysis.Basic
	Name string
	// contains filtered or unexported fields
}