openapi

package module

Go to main page

Versions in this module

v1

v1.0.7

Apr 2, 2025

v1.0.6

Apr 2, 2025

v1.0.5

Feb 24, 2025

Changes in this version

type API

+ Info openapi3.Info

+ Servers []openapi3.Server

type APIOpts

+ func WithInfo(info openapi3.Info) APIOpts

+ func WithServer(servers ...openapi3.Server) APIOpts

v1.0.4

Feb 24, 2025

v1.0.3

Feb 22, 2025

Changes in this version

type Model

+ func ModelFromType(t reflect.Type) Model

v1.0.2

Feb 22, 2025

Changes in this version

type Route

+ Deprecated bool

+ func (rm *Route) HasDeprecated(deprecated bool) *Route

v1.0.1

Feb 21, 2025

Changes in this version

+ type HeaderParam struct

+ ApplyCustomSchema func(s *openapi3.Parameter)

+ Description string

+ Required bool

+ Type PrimitiveType

type Models

+ ResponseHeaders map[int]map[string]HeaderParam

type Params

+ Header map[string]HeaderParam

type Route

+ func (rm *Route) HasHeaderParameter(name string, h HeaderParam) *Route

+ func (rm *Route) HasResponseHeader(status int, name string, h HeaderParam) *Route

v1.0.0

Feb 21, 2025

Changes in this version

+ type API struct

+ ApplyCustomSchemaToType func(t reflect.Type, s *openapi3.Schema)

+ KnownTypes map[reflect.Type]openapi3.Schema

+ Name string

+ Routes map[Pattern]MethodToRoute

+ StripPkgPaths []string

+ func NewAPI(name string, opts ...APIOpts) *API

+ func (api *API) Connect(pattern string) (r *Route)

+ func (api *API) Delete(pattern string) (r *Route)

+ func (api *API) Get(pattern string) (r *Route)

+ func (api *API) Head(pattern string) (r *Route)

+ func (api *API) Json() ([]byte, error)

+ func (api *API) Merge(r Route)

+ func (api *API) Options(pattern string) (r *Route)

+ func (api *API) Patch(pattern string) (r *Route)

+ func (api *API) Post(pattern string) (r *Route)

+ func (api *API) Put(pattern string) (r *Route)

+ func (api *API) RegisterModel(model Model, opts ...ModelOpts) (name string, schema *openapi3.Schema, err error)

+ func (api *API) Route(method, pattern string) (r *Route)

+ func (api *API) Spec() (spec *openapi3.T, err error)

+ func (api *API) Trace(pattern string) (r *Route)

+ func (api *API) Yaml() ([]byte, error)

+ type APIOpts func(*API)

+ func WithApplyCustomSchemaToType(f func(t reflect.Type, s *openapi3.Schema)) APIOpts

+ type CustomSchemaApplier interface

+ ApplyCustomSchema func(s *openapi3.Schema)

+ type Method string

+ type MethodToRoute map[Method]*Route

+ type Model struct

+ Type reflect.Type

+ func ModelOf[T any]() Model

+ func (m Model) ApplyCustomSchema(s *openapi3.Schema)

+ type ModelOpts func(s *openapi3.Schema)

+ func WithDescription(desc string) ModelOpts

+ func WithEnumConstants[T ~string | constraints.Integer]() ModelOpts

+ func WithEnumValues[T ~string | constraints.Integer](values ...T) ModelOpts

+ func WithNullable() ModelOpts

+ type Models struct

+ Request Model

+ Responses map[int]Model

+ type Params struct

+ Path map[string]PathParam

+ Query map[string]QueryParam

+ type PathParam struct

+ ApplyCustomSchema func(s *openapi3.Parameter)

+ Description string

+ Regexp string

+ Type PrimitiveType

+ type Pattern string

+ type PrimitiveType string

+ const PrimitiveTypeBool

+ const PrimitiveTypeFloat64

+ const PrimitiveTypeInteger

+ const PrimitiveTypeString

+ type QueryParam struct

+ AllowEmpty bool

+ ApplyCustomSchema func(s *openapi3.Parameter)

+ Description string

+ Regexp string

+ Required bool

+ Type PrimitiveType

+ type Route struct

+ Description string

+ Method Method

+ Models Models

+ OperationID string

+ Params Params

+ Pattern Pattern

+ Summary string

+ Tags []string

+ func (rm *Route) HasDescription(description string) *Route

+ func (rm *Route) HasOperationID(operationID string) *Route

+ func (rm *Route) HasPathParameter(name string, p PathParam) *Route

+ func (rm *Route) HasQueryParameter(name string, q QueryParam) *Route

+ func (rm *Route) HasRequestModel(request Model) *Route

+ func (rm *Route) HasResponseModel(status int, response Model) *Route

+ func (rm *Route) HasSummary(summary string) *Route

+ func (rm *Route) HasTags(tags []string) *Route

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL