openapidoc

Aug 9, 2024

Changes in this version

+ func GetContentType[T any]() (string, bool)

+ func RegisterContentType[T any](contentType string)

+ func RegisterResponse[T any](response *spec.Response)

+ func RegisterSchema[T any](schema *spec.Schema)

+ func Response(t reflect.Type) (*spec.Response, error)

type SwaggerOption

+ func AddDefaultSecurityDefinition() SwaggerOption

+ func AddSecurityDefinition(name string, securityScheme *spec.SecuritySchemeProps) SwaggerOption

Jul 25, 2024

Changes in this version

+ const DefaultSecurityDefinitionName

+ func Format(t reflect.Type) string

+ func Param(t reflect.Type, name, in string) (*spec.Parameter, error)

+ func RegisterFormat[T any](format string)

+ func Schema(t reflect.Type, requireTag bool) (*spec.Schema, error)

+ func SwaggerUI() http.Handler

+ func Type(t reflect.Type) string

+ type APIDocer interface

+ APIDoc func(context.Context) (*spec.Swagger, error)

+ type OperationMiddleware interface

+ OperationMiddleware func(*spec.Operation) *spec.Operation

+ type Operationer interface

+ Operation func(ctx context.Context) (*spec.Operation, error)

+ type Pathser interface

+ Paths func(ctx context.Context, basePath string) (*spec.Paths, error)

+ type SwaggerOption func(*spec.Swagger) *spec.Swagger

+ func BasePath(basePath string) SwaggerOption

+ func DefaultSecurityDefinition() SwaggerOption

+ func Info(info spec.InfoProps) SwaggerOption

+ func SecurityDefinition(name string, securityScheme *spec.SecuritySchemeProps) SwaggerOption