Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultDescription ¶
DefaultDescription returns a default .md description for a controller
func FuncName ¶
func FuncName(f interface{}) string
FuncName returns the name of a function and the name with package path 返回 函数名 和 包名
func NewOpenApiSpec ¶
Types ¶
type Descriptioner ¶
type Descriptioner interface {
Description() string
}
type OpenAPI ¶
type OpenAPI struct {
// contains filtered or unexported fields
}
OpenAPI Holds the OpenAPI OpenAPIDescription (OAD) and OpenAPI capabilities.
func NewOpenAPI ¶
func NewOpenAPI() *OpenAPI
func (*OpenAPI) Description ¶
func (*OpenAPI) Generator ¶
func (openAPI *OpenAPI) Generator() *openapi3gen.Generator
type Path ¶
type Path[Res, Req any] struct { Operation *openapi3.Operation FullName string Path string AcceptedContentTypes []string DefaultStatusCode int Method string Middlewares []gin.HandlerFunc // contains filtered or unexported fields }
func (*Path[Res, Req]) GenerateDefaultDescription ¶
func (p *Path[Res, Req]) GenerateDefaultDescription()
func (*Path[Res, Req]) GenerateDefaultOperationID ¶
func (p *Path[Res, Req]) GenerateDefaultOperationID()
func (*Path[Res, Req]) NameFromNamespace ¶
func (*Path[Res, Req]) RegisterOpenAPIOperation ¶
Click to show internal directories.
Click to hide internal directories.