openapi

package module

Go to main page

Versions in this module

v0

v0.3.0

Sep 9, 2026

Changes in this version

+ type APIKeyLocation string

+ const CookieLocation

+ const HeaderLocation

+ const QueryLocation

type Components

+ SecuritySchemes map[string]*SecurityScheme

type Document

+ Security []SecurityRequirement

+ Servers []Server

+ type Header struct

+ Description string

+ Example jsontext.Value

+ Required bool

+ Schema *Schema

type Info

+ Description string

type MediaType

+ Example jsontext.Value

type Operation

+ Deprecated bool

+ Description string

+ OperationID string

+ Security []SecurityRequirement

type OperationOption

+ func Deprecated() OperationOption

+ func RequestOptional() OperationOption

+ func RequestRequired() OperationOption

+ func WithDescription(description string) OperationOption

+ func WithOperationID(id string) OperationOption

+ func WithParameter(parameter Parameter) OperationOption

+ func WithRequestDescription(description string) OperationOption

+ func WithRequestExample(value any) OperationOption

+ func WithSecurity(first SecurityRequirement, alternatives ...SecurityRequirement) OperationOption

+ func WithoutSecurity() OperationOption

type Option

+ func WithDefaultSecurity(first SecurityRequirement, alternatives ...SecurityRequirement) Option

+ func WithInfoDescription(description string) Option

+ func WithSchemaTransform[T any](transform func(*Schema) error) Option

+ func WithSecurityScheme(name string, scheme SecurityScheme) Option

+ func WithServer(url, description string) Option

type Parameter

+ Deprecated bool

+ Description string

+ Example jsontext.Value

type RequestBody

+ Description string

type Response

+ Headers map[string]*Header

type ResponseOption

+ func ResponseExample(value any) ResponseOption

+ func ResponseHeader(name string, header Header) ResponseOption

type Schema

+ AllOf []*Schema

+ AnyOf []*Schema

+ Const jsontext.Value

+ Default jsontext.Value

+ Deprecated bool

+ Example jsontext.Value

+ Not *Schema

+ OneOf []*Schema

+ ReadOnly bool

+ WriteOnly bool

+ type SecurityRequirement []string

+ func (requirement SecurityRequirement) MarshalJSON() ([]byte, error)

+ type SecurityScheme struct

+ Description string

+ func APIKeyScheme(name string, location APIKeyLocation) SecurityScheme

+ func HTTPScheme(scheme, bearerFormat string) SecurityScheme

+ func (scheme SecurityScheme) MarshalJSON() ([]byte, error)

+ type Server struct

+ Description string

+ URL string

v0.2.3

Sep 2, 2026

v0.2.2

Aug 20, 2026

v0.2.1

Aug 8, 2026

Changes in this version

+ var ErrInvalidOperation = errors.New("openapi: invalid operation")

+ var ErrInvalidOption = errors.New("openapi: invalid option")

+ var ErrOperationExists = errors.New("openapi: operation already exists")

type Generator

+ func MustNew(title, version string, opts ...Option) *Generator

+ type NoBody struct

+ type OperationOption func(*operationConfig) error

+ func WithDefaultResponse[Body any](opts ...ResponseOption) OperationOption

+ func WithResponse[Body any](status int, opts ...ResponseOption) OperationOption

+ func WithSummary(summary string) OperationOption

+ func WithTags(tags ...string) OperationOption

type Option

+ func WithSchema[T any](schema *Schema) Option

+ type ResponseOption func(*responseOptions) error

+ func ResponseDescription(description string) ResponseOption

v0.2.0

Jul 8, 2026

Changes in this version

type Schema

+ ContentEncoding string

+ UniqueItems bool

v0.1.2

Jul 8, 2026

v0.1.1

Jul 8, 2026

v0.1.0

Jul 8, 2026

Changes in this version

+ func DocsHTML(title, specURL string) []byte

+ type Components struct

+ Schemas map[string]*Schema

+ type Document struct

+ Components *Components

+ Info Info

+ OpenAPI string

+ Paths map[string]PathItem

+ type Generator struct

+ func New(title, version string, opts ...Option) *Generator

+ func (g *Generator) Add(method, path string, op Op) error

+ func (g *Generator) Document() *Document

+ func (g *Generator) JSON() ([]byte, error)

+ type Info struct

+ Title string

+ Version string

+ type MediaType struct

+ Schema *Schema

+ type Op struct

+ Request any

+ Response any

+ Status int

+ Summary string

+ Tags []string

+ type Operation struct

+ Parameters []*Parameter

+ RequestBody *RequestBody

+ Responses map[string]*Response

+ Summary string

+ Tags []string

+ type Option func(*Generator)

+ func WithType(sample any, s *Schema) Option

+ func WithValidator(v *validator.Validator) Option

+ type Parameter struct

+ In string

+ Name string

+ Required bool

+ Schema *Schema

+ type PathItem map[string]*Operation

+ type RequestBody struct

+ Content map[string]*MediaType

+ Required bool

+ type Response struct

+ Content map[string]*MediaType

+ Description string

+ type Schema struct

+ AdditionalProperties *Schema

+ Description string

+ Enum []any

+ ExclusiveMaximum *float64

+ ExclusiveMinimum *float64

+ Format string

+ Items *Schema

+ MaxItems *uint64

+ MaxLength *uint64

+ Maximum *float64

+ MinItems *uint64

+ MinLength *uint64

+ Minimum *float64

+ Pattern string

+ Properties map[string]*Schema

+ Ref string

+ Required []string

+ Type string

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