vars

Documentation

Index

• type HTTPInterface
• type PathParam
• type QueryParam
• type RequestBody
• type Resource
• type ResourceHTTPInterfaceMap
• type ResponseBody
• type Scope
• type ScopeResourceHTTPInterfaceMap

Types

type HTTPInterface

type HTTPInterface struct {
	Scope    Scope
	Resource Resource

	Method     string
	URL        string
	MethodName string

	// body
	RequestBody  *RequestBody
	ResponseBody *ResponseBody

	// param
	PathParams  []*PathParam
	QueryParams []*QueryParam

	// comments
	Comments string

	IsStreamClient bool
	IsStreamServer bool
	IsSpecified    bool
}

HTTPInterface parse grpc http options, go-zero api file

type PathParam

type PathParam struct {
	Index  int
	Name   string
	GoName string
}

type QueryParam

type QueryParam struct {
	GoName string
	Name   string
}

type RequestBody

type RequestBody struct {
	Body         string // if proto. it takes effect. * or others
	RealBodyName string // if proto and body is not *. use it
	Name         string // request type name
	Type         string // proto or api
	Package      string // for example. types. *types.HelloParamRequest
}

type Resource

type Resource string

type ResourceHTTPInterfaceMap

type ResourceHTTPInterfaceMap = map[Resource][]*HTTPInterface

type ResponseBody

type ResponseBody struct {
	Name    string
	Package string
}

type Scope

type Scope string

type ScopeResourceHTTPInterfaceMap

type ScopeResourceHTTPInterfaceMap map[Scope]ResourceHTTPInterfaceMap