openapi

Feb 16, 2025

Changes in this version

+ func MarkdownGoObject(v any, m map[reflect.Type]string) string

type Document

+ func (d *Document) ParameterizedDoc(format string, params ...web.LocaleStringer) web.LocaleStringer

Feb 14, 2025

Changes in this version

+ func ParameterizedDoc(format string, f func(string) string, params ...web.LocaleStringer) web.LocaleStringer

type Document

+ func (d *Document) AppendDescriptionParameter(operationID string, item ...web.LocaleStringer)

type Operation

+ func (o *Operation) Document() *Document

Jan 7, 2025

Changes in this version

type Operation

+ func (o *Operation) SecuritySecheme(s *SecurityScheme, scope ...string) *Operation

Dec 4, 2024

Changes in this version

+ const EmptyResponseRef

type Operation

+ func (o *Operation) Response200(resp any) *Operation

+ func (o *Operation) ResponseEmpty(status string) *Operation

Dec 4, 2024

Changes in this version

type Document

+ func (d *Document) WithDescription(summary, desc web.LocaleStringer)

+ func (d *Document) WithHTML(tpl, assets, logo string)

+ func (d *Document) WithSecurityScheme(s *SecurityScheme, scope ...[]string)

+ func (d *Document) WithServer(url string, desc web.LocaleStringer, vars ...*ServerVariable)

+ func (d *Document) WithTag(name string, desc web.LocaleStringer, extDocURL string, ...)

Dec 3, 2024

Changes in this version

+ type OpenAPISchema interface

+ OpenAPISchema func(s *Schema)

Dec 2, 2024

Changes in this version

type Option

+ func WithClassicResponse() Option

+ func WithHeadMethod(enable bool) Option

+ func WithOptionsMethod(enable bool) Option

Dec 2, 2024

Changes in this version

+ func MarkdownProblems(s web.Server) web.LocaleStringer

type Schema

+ Default any

+ func AllOfSchema(title, desc web.LocaleStringer, v ...any) *Schema

+ func AnyOfSchema(title, desc web.LocaleStringer, v ...any) *Schema

+ func OneOfSchema(title, desc web.LocaleStringer, v ...any) *Schema

Nov 25, 2024

Changes in this version

+ const FormatBinary

+ const FormatByte

Nov 23, 2024

Changes in this version

+ const FormatDate

+ const FormatDateTime

+ const FormatTime

type Operation

+ func (o *Operation) Desc(summary, description web.LocaleStringer) *Operation

+ func (o *Operation) PathID(name string, desc web.LocaleStringer) *Operation

Nov 21, 2024

Changes in this version

+ const CommentTag

+ const FormatDouble

+ const FormatFloat

+ const FormatInt32

+ const FormatInt64

+ const FormatPassword

+ const InCookie

+ const InHeader

+ const InPath

+ const InQuery

+ const SecuritySchemeTypeAPIKey

+ const SecuritySchemeTypeHTTP

+ const SecuritySchemeTypeMutualTLS

+ const SecuritySchemeTypeOAuth2

+ const SecuritySchemeTypeOpenIDConnect

+ const TypeArray

+ const TypeBoolean

+ const TypeInteger

+ const TypeNull

+ const TypeNumber

+ const TypeObject

+ const TypeString

+ const Version

+ type Callback struct

+ Callback map[string]*PathItem

+ Ref *Ref

+ type Document struct

+ func New(s web.Server, title web.LocaleStringer, o ...Option) *Document

+ func (d *Document) API(f func(o *Operation)) web.Middleware

+ func (d *Document) AddWebhook(name, method string, o *Operation)

+ func (d *Document) Disable(disable bool)

+ func (d *Document) Handler(ctx *web.Context) web.Responser

+ type ExternalDocs struct

+ Description web.LocaleStringer

+ URL string

+ type OAuthFlow struct

+ AuthorizationURL string

+ RefreshURL string

+ Scopes map[string]web.LocaleStringer

+ TokenURL string

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Implicit *OAuthFlow

+ Password *OAuthFlow

+ type Operation struct

+ Callbacks map[string]*Callback

+ Cookies []*Parameter

+ Deprecated bool

+ Description web.LocaleStringer

+ ExternalDocs *ExternalDocs

+ Headers []*Parameter

+ ID string

+ Paths []*Parameter

+ Queries []*Parameter

+ RequestBody *Request

+ Responses map[string]*Response

+ Security []*SecurityRequirement

+ Servers []*Server

+ Summary web.LocaleStringer

+ Tags []string

+ func (m *Operation) QueryObject(o any, f func(*Parameter)) *Operation

+ func (o *Operation) Body(body any, ignorable bool, desc web.LocaleStringer, f func(*Request)) *Operation

+ func (o *Operation) BodyRef(ref string) *Operation

+ func (o *Operation) Callback(name, path, method string, f func(*Operation)) *Operation

+ func (o *Operation) CallbackRef(name, ref string) *Operation

+ func (o *Operation) Cookie(name, typ string, desc web.LocaleStringer, f func(*Parameter)) *Operation

+ func (o *Operation) CookieRef(ref string) *Operation

+ func (o *Operation) Header(name, typ string, desc web.LocaleStringer, f func(*Parameter)) *Operation

+ func (o *Operation) HeaderRef(ref string) *Operation

+ func (o *Operation) Path(name, typ string, desc web.LocaleStringer, f func(*Parameter)) *Operation

+ func (o *Operation) PathRef(ref string) *Operation

+ func (o *Operation) Query(name, typ string, desc web.LocaleStringer, f func(*Parameter)) *Operation

+ func (o *Operation) QueryRef(ref string) *Operation

+ func (o *Operation) Response(status string, resp any, desc web.LocaleStringer, f func(*Response)) *Operation

+ func (o *Operation) ResponseRef(status string, ref string) *Operation

+ func (o *Operation) Server(url string, desc web.LocaleStringer, vars ...*ServerVariable) *Operation

+ func (o *Operation) Tag(tag ...string) *Operation

+ type Option func(*Document)

+ func WithCallback(c ...*Callback) Option

+ func WithContact(name, email, url string) Option

+ func WithCookie(global bool, p ...*Parameter) Option

+ func WithDescription(summary, desc web.LocaleStringer) Option

+ func WithExternalDocs(url string, desc web.LocaleStringer) Option

+ func WithHTML(tpl, assets, favicon string) Option

+ func WithHead(enable bool) Option

+ func WithHeader(global bool, p ...*Parameter) Option

+ func WithLicense(name, id string) Option

+ func WithMediaType(t ...string) Option

+ func WithOptions(enable bool) Option

+ func WithPath(global bool, p ...*Parameter) Option

+ func WithProblemResponse() Option

+ func WithQuery(p ...*Parameter) Option

+ func WithResponse(resp *Response, status ...string) Option

+ func WithSecurityScheme(s *SecurityScheme, scope ...[]string) Option

+ func WithServer(url string, desc web.LocaleStringer, vars ...*ServerVariable) Option

+ func WithTag(name string, desc web.LocaleStringer, extDocURL string, ...) Option

+ func WithTerms(url string) Option

+ type Parameter struct

+ Deprecated bool

+ Description web.LocaleStringer

+ Name string

+ Ref *Ref

+ Required bool

+ Schema *Schema

+ type PathItem struct

+ Cookies []*Parameter

+ Headers []*Parameter

+ Operations map[string]*Operation

+ Paths []*Parameter

+ Queries []*Parameter

+ Ref *Ref

+ Servers []*Server

+ type Ref struct

+ Description web.LocaleStringer

+ Ref string

+ Summary web.LocaleStringer

+ type Request struct

+ Body *Schema

+ Content map[string]*Schema

+ Description web.LocaleStringer

+ Ignorable bool

+ Ref *Ref

+ type Response struct

+ Body *Schema

+ Content map[string]*Schema

+ Description web.LocaleStringer

+ Headers []*Parameter

+ Problem bool

+ Ref *Ref

+ type Schema struct

+ AdditionalProperties *Schema

+ AllOf []*Schema

+ AnyOf []*Schema

+ Description web.LocaleStringer

+ Enum []any

+ ExternalDocs *ExternalDocs

+ Format string

+ Items *Schema

+ Maximum int

+ Minimum int

+ OneOf []*Schema

+ Properties map[string]*Schema

+ Ref *Ref

+ Required []string

+ Title web.LocaleStringer

+ Type string

+ XML *XML

+ func NewSchema(t reflect.Type, title, desc web.LocaleStringer) *Schema

+ type SecurityRequirement struct

+ Name string

+ Scopes []string

+ type SecurityScheme struct

+ BearerFormat string

+ Description web.LocaleStringer

+ Flows *OAuthFlows

+ ID string

+ In string

+ Name string

+ OpenIDConnectURL string

+ Scheme string

+ Type string

+ type Server struct

+ Description web.LocaleStringer

+ URL string

+ Variables []*ServerVariable

+ type ServerVariable struct

+ Default string

+ Description web.LocaleStringer

+ Enums []string

+ Name string

+ type XML struct

+ Attribute bool

+ Name string

+ Namespace string

+ Prefix string

+ Wrapped bool