api

Documentation

Index

• type GenerationInfo
• type HTTPMethod
• type Interface
• type MetricsPlaceholder
• type Placeholder
• type SwaggerInfo

Types

type GenerationInfo

type GenerationInfo struct {
	Interfaces []*Interface

	SwaggerInfo
	Swagger              *v1.Swagger
	SwaggerToJSON        *bool
	SwaggerToYaml        *bool
	SwaggerAbsOutputPath string
}

GenerationInfo present generation info

type HTTPMethod

type HTTPMethod struct {
	Method                  string
	APIPath                 string
	RawURIPath              string
	URIPath                 string
	ClientURIPath           string
	ErrorProcessor          string
	URIPathPlaceholders     []string
	QueryPlaceholders       map[string]*Placeholder
	IsIntQueryPlaceholders  bool
	HeaderPlaceholders      map[string]string
	CookiePlaceholders      map[string]string
	ContentType             string
	JSONTags                map[string]string
	PlainObject             string
	MultipartValueTags      map[string]string
	MultipartFileTags       map[string]string
	FormUrlencodedTags      map[string]string
	Body                    map[string]string
	BodyPlaceholders        map[string]*Placeholder
	IsIntBodyPlaceholders   bool
	ResponseHeaders         map[string]string
	ResponseStatus          string
	ResponseContentType     string
	ResponseContentEncoding string
	ResponseJSONTags        map[string]string
	ResponseBody            map[string]string
	ResponseFile            string
	ResponseFileName        string
	ResponseBodyField       string
	LogIgnores              []string
	AdditionalMetricsLabels map[string]*MetricsPlaceholder

	SwaggerInfo
}

HTTPMethod ...

type Interface

type Interface struct {
	PkgName       string
	AbsOutputPath string
	RelOutputPath string
	Iface         types.Interface
	IsTLSClient   bool
	IsInsecureTLS bool
	HTTPMethods   map[string]HTTPMethod

	SwaggerInfo
}

Interface ...

type MetricsPlaceholder

type MetricsPlaceholder struct {
	IsString  bool
	IsInt     bool
	IsPointer bool
	Name      string
}

MetricsPlaceholder ...

type Placeholder

type Placeholder struct {
	IsPointer bool
	IsString  bool
	IsInt     bool
	Type      string
	Name      string
}

Placeholder ...

type SwaggerInfo

type SwaggerInfo struct {
	Description *string
	Summary     *string
	Title       *string
	Version     *string
	Servers     []v1.Server
}

SwaggerInfo ...