Documentation
¶
Index ¶
- type ExternalDocsOverride
- type GroupBuilder
- func (b *GroupBuilder) Deprecate(d bool) *GroupBuilder
- func (b *GroupBuilder) GetDeprecated() bool
- func (b *GroupBuilder) GetSecurity() []string
- func (b *GroupBuilder) GetTags() []string
- func (b *GroupBuilder) Security(schemeName ...string) *GroupBuilder
- func (b *GroupBuilder) Tag(tags ...string) *GroupBuilder
- type HandlerBuilder
- func (hb *HandlerBuilder[T]) AddParameter(in, name, desc string, req, dep bool) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) AddResponse(code int, content any) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) AddServer(url, desc string) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) Deprecate(d bool) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) Description(d string) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) Extensions(ext map[string]any) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) ExternalDocs(url, desc string) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) OperationID(id string) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) RequestBody(obj any) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) ResponseHeader(code int, name, desc string) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) Security(schemeName ...string) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) Summary(s string) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) Tag(tags ...string) *HandlerBuilder[T]
- func (hb *HandlerBuilder[T]) Unwrap() T
- type HandlerMetadata
- type ParameterOverride
- type ResponseHeaderOverride
- type ResponseOverride
- type ServerOverride
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ExternalDocsOverride ¶ added in v0.3.2
type GroupBuilder ¶ added in v0.2.1
type GroupBuilder struct {
// contains filtered or unexported fields
}
func Meta ¶ added in v0.2.2
func Meta(router interface{}) *GroupBuilder
func NewGroupBuilder ¶ added in v0.2.2
func NewGroupBuilder() *GroupBuilder
func (*GroupBuilder) Deprecate ¶ added in v0.3.2
func (b *GroupBuilder) Deprecate(d bool) *GroupBuilder
func (*GroupBuilder) GetDeprecated ¶ added in v0.3.2
func (b *GroupBuilder) GetDeprecated() bool
func (*GroupBuilder) GetSecurity ¶ added in v0.2.2
func (b *GroupBuilder) GetSecurity() []string
func (*GroupBuilder) GetTags ¶ added in v0.2.2
func (b *GroupBuilder) GetTags() []string
func (*GroupBuilder) Security ¶ added in v0.2.1
func (b *GroupBuilder) Security(schemeName ...string) *GroupBuilder
func (*GroupBuilder) Tag ¶ added in v0.2.1
func (b *GroupBuilder) Tag(tags ...string) *GroupBuilder
type HandlerBuilder ¶ added in v0.2.9
type HandlerBuilder[T any] struct { // contains filtered or unexported fields }
func Handler ¶ added in v0.2.1
func Handler[T any](handler T) *HandlerBuilder[T]
func (*HandlerBuilder[T]) AddParameter ¶ added in v0.3.2
func (hb *HandlerBuilder[T]) AddParameter(in, name, desc string, req, dep bool) *HandlerBuilder[T]
func (*HandlerBuilder[T]) AddResponse ¶ added in v0.3.2
func (hb *HandlerBuilder[T]) AddResponse(code int, content any) *HandlerBuilder[T]
func (*HandlerBuilder[T]) AddServer ¶ added in v0.3.2
func (hb *HandlerBuilder[T]) AddServer(url, desc string) *HandlerBuilder[T]
func (*HandlerBuilder[T]) Deprecate ¶ added in v0.3.2
func (hb *HandlerBuilder[T]) Deprecate(d bool) *HandlerBuilder[T]
func (*HandlerBuilder[T]) Description ¶ added in v0.2.9
func (hb *HandlerBuilder[T]) Description(d string) *HandlerBuilder[T]
func (*HandlerBuilder[T]) Extensions ¶ added in v0.3.5
func (hb *HandlerBuilder[T]) Extensions(ext map[string]any) *HandlerBuilder[T]
func (*HandlerBuilder[T]) ExternalDocs ¶ added in v0.3.2
func (hb *HandlerBuilder[T]) ExternalDocs(url, desc string) *HandlerBuilder[T]
func (*HandlerBuilder[T]) OperationID ¶ added in v0.3.2
func (hb *HandlerBuilder[T]) OperationID(id string) *HandlerBuilder[T]
func (*HandlerBuilder[T]) RequestBody ¶ added in v0.3.2
func (hb *HandlerBuilder[T]) RequestBody(obj any) *HandlerBuilder[T]
func (*HandlerBuilder[T]) ResponseHeader ¶ added in v0.3.2
func (hb *HandlerBuilder[T]) ResponseHeader(code int, name, desc string) *HandlerBuilder[T]
func (*HandlerBuilder[T]) Security ¶ added in v0.2.9
func (hb *HandlerBuilder[T]) Security(schemeName ...string) *HandlerBuilder[T]
func (*HandlerBuilder[T]) Summary ¶ added in v0.2.9
func (hb *HandlerBuilder[T]) Summary(s string) *HandlerBuilder[T]
func (*HandlerBuilder[T]) Tag ¶ added in v0.2.9
func (hb *HandlerBuilder[T]) Tag(tags ...string) *HandlerBuilder[T]
func (*HandlerBuilder[T]) Unwrap ¶ added in v0.2.9
func (hb *HandlerBuilder[T]) Unwrap() T
type HandlerMetadata ¶ added in v0.2.9
type HandlerMetadata struct {
Summary string
Description string
Tags []string
Security []string
RequestBodyExpr ast.Expr
Responses []ResponseOverride
Parameters []ParameterOverride
ResponseHeaders []ResponseHeaderOverride
Servers []ServerOverride
ExternalDocs *ExternalDocsOverride
OperationID string
Deprecated bool
Extensions map[string]any
}
type ParameterOverride ¶ added in v0.3.2
type ResponseHeaderOverride ¶ added in v0.3.2
type ResponseOverride ¶ added in v0.3.2
type ServerOverride ¶ added in v0.3.2
Click to show internal directories.
Click to hide internal directories.