parser

Documentation

Index

• Variables
• func BuildAnnotations(g *protogen.GeneratedFile, m *protogen.Method, config *SwagParams) (string, error)
• func ConvertGinToSwaggerPath(ginPath string) string
• func FindProtoField(message *protogen.Message, keypath []string) *protogen.Field
• func GinRoute(protoPath string) (string, error)
• func MethodCommend(m *protogen.Method) string
• func ProtoKeyPath2GoKeyPath(message *protogen.Message, keypath []string) []string
• func ProtoTypeToGoType(g *protogen.GeneratedFile, field *protogen.Field, usePtrForMessage bool) string
• type HeaderField
  • func GinHeaderParams(m *protogen.Method) ([]HeaderField, error)
• type HttpRule
  • func ParseHttpRule(rule *annotations.HttpRule) *HttpRule
• type QueryFormField
  • func GinQueryForm(m *protogen.Method, method string, pathVars []URIParamsField) ([]QueryFormField, error)
• type SwagParams
• type URIParamsField
  • func GinURIParams(m *protogen.Method, route string) ([]URIParamsField, error)

Variables

var NoBodyMethods = map[string]struct{}{
	http.MethodGet:     {},
	http.MethodHead:    {},
	http.MethodDelete:  {},
	http.MethodOptions: {},
}

Functions

func BuildAnnotations

func BuildAnnotations(g *protogen.GeneratedFile, m *protogen.Method, config *SwagParams) (string, error)

func ConvertGinToSwaggerPath

func ConvertGinToSwaggerPath(ginPath string) string

func FindProtoField

func FindProtoField(message *protogen.Message, keypath []string) *protogen.Field

func GinRoute

func GinRoute(protoPath string) (string, error)

func MethodCommend

func MethodCommend(m *protogen.Method) string

func ProtoKeyPath2GoKeyPath

func ProtoKeyPath2GoKeyPath(message *protogen.Message, keypath []string) []string

func ProtoTypeToGoType

func ProtoTypeToGoType(g *protogen.GeneratedFile, field *protogen.Field, usePtrForMessage bool) string

Types

type HeaderField

type HeaderField struct {
	Name  string
	Field *protogen.Field
}

func GinHeaderParams

func GinHeaderParams(m *protogen.Method) ([]HeaderField, error)

type HttpRule

type HttpRule struct {
	Path         string
	Method       string
	HasBody      bool
	Body         string
	ResponseBody string
}

func ParseHttpRule

func ParseHttpRule(rule *annotations.HttpRule) *HttpRule

type QueryFormField

type QueryFormField struct {
	Name  string
	Field *protogen.Field
}

func GinQueryForm

func GinQueryForm(m *protogen.Method, method string, pathVars []URIParamsField) ([]QueryFormField, error)

type SwagParams

type SwagParams struct {
	Method string
	Path   string
	Auth   string

	PathVars   []URIParamsField
	QueryVars  []QueryFormField
	HeaderVars []HeaderField

	Body         string
	ResponseBody string

	DataResponse  string
	ErrorResponse string
}

type URIParamsField

type URIParamsField struct {
	Name     string
	Wildcard bool
	Field    *protogen.Field
}

func GinURIParams

func GinURIParams(m *protogen.Method, route string) ([]URIParamsField, error)