swagger

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 16, 2023 License: Apache-2.0 Imports: 5 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// optional trpc.SwaggerRule swagger = 50101;
	E_Swagger = &file_trpc_swagger_swagger_proto_extTypes[0]
)

Extension fields to descriptorpb.MethodOptions.

View Source
var File_trpc_swagger_swagger_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type SwaggerParam

type SwaggerParam struct {
	Name     string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Required bool   `protobuf:"varint,2,opt,name=required,proto3" json:"required,omitempty"`
	Default  string `protobuf:"bytes,3,opt,name=default,proto3" json:"default,omitempty"`
	// contains filtered or unexported fields
}

func (*SwaggerParam) Descriptor deprecated

func (*SwaggerParam) Descriptor() ([]byte, []int)

Deprecated: Use SwaggerParam.ProtoReflect.Descriptor instead.

func (*SwaggerParam) GetDefault

func (x *SwaggerParam) GetDefault() string

func (*SwaggerParam) GetName

func (x *SwaggerParam) GetName() string

func (*SwaggerParam) GetRequired

func (x *SwaggerParam) GetRequired() bool

func (*SwaggerParam) ProtoMessage

func (*SwaggerParam) ProtoMessage()

func (*SwaggerParam) ProtoReflect

func (x *SwaggerParam) ProtoReflect() protoreflect.Message

func (*SwaggerParam) Reset

func (x *SwaggerParam) Reset()

func (*SwaggerParam) String

func (x *SwaggerParam) String() string

type SwaggerRule

type SwaggerRule struct {
	Title       string          `protobuf:"bytes,50103,opt,name=title,proto3" json:"title,omitempty"`
	Method      string          `protobuf:"bytes,50104,opt,name=method,proto3" json:"method,omitempty"`
	Description string          `protobuf:"bytes,50105,opt,name=description,proto3" json:"description,omitempty"`
	Params      []*SwaggerParam `protobuf:"bytes,50106,rep,name=params,proto3" json:"params,omitempty"`
	// contains filtered or unexported fields
}

to gen swagger json

func (*SwaggerRule) Descriptor deprecated

func (*SwaggerRule) Descriptor() ([]byte, []int)

Deprecated: Use SwaggerRule.ProtoReflect.Descriptor instead.

func (*SwaggerRule) GetDescription

func (x *SwaggerRule) GetDescription() string

func (*SwaggerRule) GetMethod

func (x *SwaggerRule) GetMethod() string

func (*SwaggerRule) GetParams

func (x *SwaggerRule) GetParams() []*SwaggerParam

func (*SwaggerRule) GetTitle

func (x *SwaggerRule) GetTitle() string

func (*SwaggerRule) ProtoMessage

func (*SwaggerRule) ProtoMessage()

func (*SwaggerRule) ProtoReflect

func (x *SwaggerRule) ProtoReflect() protoreflect.Message

func (*SwaggerRule) Reset

func (x *SwaggerRule) Reset()

func (*SwaggerRule) String

func (x *SwaggerRule) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL