Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

openapi

package module

Go to main page

Versions in this module

v0

v0.4.0

May 9, 2026

Changes in this version

+ const RouteManifestVersion

+ func ApplyFilters(spec *openapi3.T, filters ...Filter) error

+ func CleanHandlerName(name string) string

+ type Filter func(*openapi3.T) error

+ func ExcludeOperationsWithExtensionValue(extension string, value any) Filter

+ func FilterOperationExpression(expression string) (Filter, error)

+ func FilterOperations(keep func(OperationContext) bool) Filter

+ func PruneUnusedComponents() Filter

+ func StripOperationExtension(extension string) Filter

type Generator

+ func NewFromRouteManifest(manifest RouteManifest, opts ...Option) *Generator

+ func (g *Generator) Err() error

+ func (g *Generator) SpecErr() (*openapi3.T, error)

+ func (g *Generator) WarningsErr() ([]string, error)

+ type OperationContext struct

+ Method string

+ Operation *openapi3.Operation

+ OperationID string

+ Path string

+ PathItem *openapi3.PathItem

+ func (o OperationContext) Extension(name string) (any, bool)

+ func (o OperationContext) ExtensionBoolDefault(name string, fallback bool) bool

type Option

+ func WithFilters(filters ...Filter) Option

+ type RouteManifest struct

+ Routes []RouteManifestRoute

+ Version string

+ type RouteManifestField struct

+ Anonymous bool

+ Name string

+ PkgPath string

+ Tag string

+ Type RouteManifestType

+ type RouteManifestRoute struct

+ Handler string

+ HandlerName string

+ HandlerType string

+ InputTypes []RouteManifestType

+ Inputs []string

+ Method string

+ Path string

+ ResultTypes []RouteManifestType

+ Results []string

+ func (route RouteManifestRoute) HandlerSymbol() string

+ type RouteManifestType struct

+ Elem *RouteManifestType

+ Fields []RouteManifestField

+ Key *RouteManifestType

+ Kind string

+ Name string

+ PkgPath string

+ String string

+ TypeArgs []RouteManifestType

v0.3.0

May 5, 2026

v0.2.1

May 5, 2026

v0.2.0

May 5, 2026

v0.1.0

May 4, 2026

Changes in this version

+ func ApplySpecMetadata(spec *openapi3.T, metadata SpecMetadata)

+ func HTTPBearerSecurity(description string) *openapi3.SecurityScheme

+ func JSONHandler(g *Generator) fox.HandlerFunc

+ func MarshalSpecJSON(spec *openapi3.T) ([]byte, error)

+ func MarshalSpecYAML(spec *openapi3.T) ([]byte, error)

+ func Mount(router Router, g *Generator, opts ...MountOption)

+ func YAMLHandler(g *Generator) fox.HandlerFunc

+ type Generator struct

+ func New(engine *fox.Engine, opts ...Option) *Generator

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

+ func (g *Generator) Regenerate()

+ func (g *Generator) Spec() *openapi3.T

+ func (g *Generator) Warnings() []string

+ func (g *Generator) WriteYAML(w io.Writer) error

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

+ type MountOption func(*mountConfig)

+ func MountJSON(path string) MountOption

+ func MountYAML(path string) MountOption

+ type OAuthFlowConfig struct

+ AuthorizationURL string

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlowsConfig struct

+ AuthorizationCode *OAuthFlowConfig

+ ClientCredentials *OAuthFlowConfig

+ Implicit *OAuthFlowConfig

+ Password *OAuthFlowConfig

+ type OperationOption func(*operationDoc)

+ func Deprecated(value bool) OperationOption

+ func Description(value string) OperationOption

+ func OperationID(value string) OperationOption

+ func Response(status int, body any, description string) OperationOption

+ func Security(name string, scopes ...string) OperationOption

+ func Summary(value string) OperationOption

+ func Tags(values ...string) OperationOption

+ type Option func(*Generator)

+ func Group(prefix string, opts ...OperationOption) Option

+ func Info(title, version string) Option

+ func Operation(method, path string, opts ...OperationOption) Option

+ func RegisterFormatter(typ reflect.Type, schema *openapi3.Schema) Option

+ func SecurityScheme(name string, scheme *openapi3.SecurityScheme) Option

+ func SecuritySchemeFromConfig(name string, scheme SecuritySchemeConfig) Option

+ func Server(url string) Option

+ func SetErrorSchema(body any) Option

+ func Source(paths []string, opts ...SourceOption) Option

+ type Router interface

+ GET func(relativePath string, handlers ...fox.HandlerFunc) gin.IRoutes

+ type SecuritySchemeConfig struct

+ BearerFormat string

+ Description string

+ Flows *OAuthFlowsConfig

+ In string

+ Name string

+ OpenIDConnectURL string

+ Scheme string

+ Type string

+ type SourceOption func(*sourceConfig)

+ func IncludeTestFiles() SourceOption

+ type SpecExternalDocs struct

+ Description string

+ URL string

+ type SpecMetadata struct

+ InfoDescription string

+ ServerDescriptions []string

+ Tags []SpecTag

+ type SpecTag struct

+ Description string

+ ExternalDocs *SpecExternalDocs

+ Name string