common

Documentation

Index

• type Api
• type Endpoint
• type Field
• type Method
• type Param
• type Response
• type Status
• type Struct
  • func (s Struct) FullName() string

Types

type Api

type Api struct {
	Status    Status
	Endpoints []Endpoint
	Structs   map[string]Struct
}

type Endpoint

type Endpoint struct {
	Name        string
	Method      string
	Path        string
	PathParams  map[string]Param
	QueryParams map[string]Param
	Headers     map[string]Param
	Body        *string
	Responses   []Response
}

type Field

type Field struct {
	Name     string
	Type     string
	Optional bool
	Array    bool
}

type Method

type Method struct {
	Package  string
	Name     string
	Comments []string
}

type Param

type Param struct {
	Type     string
	Desc     string
	Required bool
}

type Response

type Response struct {
	Code int
	Type *string
}

type Status

type Status struct {
	Title   string
	Version string
	URL     string
	Output  string
}

type Struct

type Struct struct {
	Package string
	Name    string
	Fields  []Field
}

func (Struct) FullName

func (s Struct) FullName() string