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
- API
  
  Reference documentation for the pkg.go.dev API
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

expose

package module

Go to main page

Versions in this module

v0

v0.3.0

Aug 24, 2026

Changes in this version

+ func FilterSpec(spec openapi3.T, prefix string, depth int) openapi3.T

type FuncOpt

+ func Deprecated() FuncOpt

+ func Description(description string) FuncOpt

+ func Extension(key string, value any) FuncOpt

+ func OperationCustomizer(customize func(op *openapi3.Operation)) FuncOpt

+ func Summary(summary string) FuncOpt

+ func Tags(tags ...string) FuncOpt

type Function

+ func Describe(fn Function, opts ...FuncOpt) Function

+ func Module(pathPrefix string, description string, fns ...Function) []Function

+ type ModuleDoc struct

+ Description string

+ Path string

+ type ModuleDocumenter interface

+ ModuleDocs func() []ModuleDoc

+ type OperationAnnotator interface

+ AnnotateOperation func(op *openapi3.Operation)

v0.2.0

Feb 9, 2026

Changes in this version

+ func WithSchemaCustomizers(customizers ...SchemaCustomizer) reflectSpecOpt

+ type SchemaCustomizer func(name string, t reflect.Type, tag reflect.StructTag, schema *openapi3.Schema) (stop bool, err error)

v0.1.2

Jul 28, 2025

v0.1.1

Jul 28, 2025

v0.1.0

Jul 28, 2025

Changes in this version

+ var ErrApplication = errors.New("application error")

+ var JsonEncoding = Encoding

+ func DefaultSchemaIdentifier(t reflect.Type) string

+ func GetErrCode(err error) (string, bool)

+ func ReflectSpec(root openapi3.T, fns []Function, opts ...reflectSpecOpt) (openapi3.T, error)

+ func SetErrCode(err error, code string) error

+ func ShortSchemaIdentifier(t reflect.Type) string

+ func SkipExtractSubSchemas(skip ...bool) reflectSpecOpt

+ func WithSchemaIdentifier(namer SchemaIdentifier) reflectSpecOpt

+ func WithSchemaMapper(mapper SchemaMapper) reflectSpecOpt

+ type Decoder interface

+ Decode func(v any) error

+ type DecoderFunc func(v any) error

+ func (f DecoderFunc) Decode(v any) error

+ type Encoder interface

+ Encode func(v any) error

+ type EncoderFunc func(v any) error

+ func (f EncoderFunc) Encode(v any) error

+ type Encoding struct

+ GetDecoder func(r io.Reader) Decoder

+ GetEncoder func(w io.Writer) Encoder

+ MimeType string

+ type ErrWithCode struct

+ func (e ErrWithCode) Code() string

+ func (e ErrWithCode) Error() string

+ type ErrorHandler func(w http.ResponseWriter, enc Encoder, err error) (handled bool)

+ type FuncOpt func(s *functionSettings)

+ func Validate(validate bool) FuncOpt

+ type Function interface

+ Apply func(ctx context.Context, dec Decoder, spec openapi3.T) (any, error)

+ Module func() string

+ Name func() string

+ Path func() string

+ Req func() any

+ Res func() any

+ func FuncNullaryVoid(mountpoint string, fn func(ctx context.Context) error, opts ...FuncOpt) Function

+ func FuncNullary[TRes any](mountpoint string, fn func(ctx context.Context) (TRes, error), opts ...FuncOpt) Function

+ func FuncVoid[TReq any](mountpoint string, fn func(ctx context.Context, req TReq) error, ...) Function

+ func Func[TReq any, TRes any](mountpoint string, fn func(ctx context.Context, req TReq) (TRes, error), ...) Function

+ func Struct(basePath string, v any, opts ...FuncOpt) []Function

+ type Handler struct

+ func NewHandler(fns []Function, options ...HandlerOption) (*Handler, error)

+ type HandlerOption func(settings *handlerSettings)

+ func WithDefaultSpec(spec *openapi3.T) HandlerOption

+ func WithEncodings(encodings ...Encoding) HandlerOption

+ func WithErrorHandler(h ErrorHandler) HandlerOption

+ func WithPathPrefix(prefixPath string) HandlerOption

+ func WithReflection(opts ...reflectSpecOpt) HandlerOption

+ func WithSwaggerJSONPath(path string) HandlerOption

+ func WithSwaggerUI(path string) HandlerOption

+ type Middleware func(next http.Handler) http.Handler

+ type SchemaIdentifier func(t reflect.Type) string

+ type SchemaMapper func(t reflect.Type) *openapi3.Schema

+ type SchemaProvider interface

+ JSONSchema func(gen *openapi3gen.Generator, schemas openapi3.Schemas) (*openapi3.SchemaRef, error)

+ type SwaggerUIHandler struct

+ func NewSwaggerUIHandler(defaultSpec openapi3.T, fns []Function) *SwaggerUIHandler

+ type Void struct

+ func (v *Void) UnmarshalJSON(b []byte) error

+ type WithCode interface

+ Code func() string