openapidoc

Documentation

Index

• Constants
• func Format(t reflect.Type) string
• func GetContentType[T any]() (string, bool)
• func Param(t reflect.Type, name, in string) (*spec.Parameter, error)
• func RegisterContentType[T any](contentType string)
• func RegisterFormat[T any](format string)
• func RegisterResponse[T any](response *spec.Response)
• func RegisterSchema[T any](schema *spec.Schema)
• func Response(t reflect.Type) (*spec.Response, error)
• func Schema(t reflect.Type, requireTag bool) (*spec.Schema, error)
• func SwaggerUI() http.Handler
• func Type(t reflect.Type) string
• type APIDocer
• type OperationMiddleware
• type Operationer
• type Pathser
• type SwaggerOption
  • func AddDefaultSecurityDefinition() SwaggerOption
  • func AddSecurityDefinition(name string, securityScheme *spec.SecuritySchemeProps) SwaggerOption
  • func BasePath(basePath string) SwaggerOption
  • func Info(info spec.InfoProps) SwaggerOption

Constants

const DefaultSecurityDefinitionName = "Bearer"

Functions

func Format

func Format(t reflect.Type) string

func GetContentType

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

func Param

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

func RegisterContentType

func RegisterContentType[T any](contentType string)

func RegisterFormat

func RegisterFormat[T any](format string)

func RegisterResponse

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

func RegisterSchema

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

func Response

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

func Schema

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

func SwaggerUI

func SwaggerUI() http.Handler

func Type

func Type(t reflect.Type) string

Types

type APIDocer

type APIDocer interface {
	APIDoc(context.Context) (*spec.Swagger, error)
}

type OperationMiddleware

type OperationMiddleware interface {
	OperationMiddleware(*spec.Operation) *spec.Operation
}

type Operationer

type Operationer interface {
	Operation(ctx context.Context) (*spec.Operation, error)
}

type Pathser

type Pathser interface {
	Paths(ctx context.Context, basePath string) (*spec.Paths, error)
}

type SwaggerOption

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

func AddDefaultSecurityDefinition

func AddDefaultSecurityDefinition() SwaggerOption

func AddSecurityDefinition

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

func BasePath

func BasePath(basePath string) SwaggerOption

func Info

func Info(info spec.InfoProps) SwaggerOption