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

api

package

Go to main page

Versions in this module

v1

v1.0.0

Jun 5, 2025

Changes in this version

+ type UnimplementedHandler struct

+ func (UnimplementedHandler) Healthz(ctx context.Context) (r *Healthy, _ error)

+ func (UnimplementedHandler) NewError(ctx context.Context, err error) (r *ErrorRespStatusCode)

v0

v0.2.0

May 5, 2025

v0.1.2

May 5, 2025

v0.1.1

Mar 18, 2025

v0.1.0

Mar 18, 2025

v0.0.2

Mar 18, 2025

v0.0.1

Mar 7, 2025

Changes in this version

+ type Error struct

+ Error string

+ func (s *Error) Decode(d *jx.Decoder) error

+ func (s *Error) Encode(e *jx.Encoder)

+ func (s *Error) GetError() string

+ func (s *Error) MarshalJSON() ([]byte, error)

+ func (s *Error) SetError(val string)

+ func (s *Error) UnmarshalJSON(data []byte) error

+ type ErrorHandler = ogenerrors.ErrorHandler

+ type ErrorRespStatusCode struct

+ Response Error

+ StatusCode int

+ func (s *ErrorRespStatusCode) Error() string

+ func (s *ErrorRespStatusCode) GetResponse() Error

+ func (s *ErrorRespStatusCode) GetStatusCode() int

+ func (s *ErrorRespStatusCode) SetResponse(val Error)

+ func (s *ErrorRespStatusCode) SetStatusCode(val int)

+ type Handler interface

+ Healthz func(ctx context.Context) (*Healthy, error)

+ NewError func(ctx context.Context, err error) *ErrorRespStatusCode

+ type Healthy struct

+ Message string

+ func (s *Healthy) Decode(d *jx.Decoder) error

+ func (s *Healthy) Encode(e *jx.Encoder)

+ func (s *Healthy) GetMessage() string

+ func (s *Healthy) MarshalJSON() ([]byte, error)

+ func (s *Healthy) SetMessage(val string)

+ func (s *Healthy) UnmarshalJSON(data []byte) error

+ type Labeler struct

+ func LabelerFromContext(ctx context.Context) (*Labeler, bool)

+ func (l *Labeler) Add(attrs ...attribute.KeyValue)

+ func (l *Labeler) AttributeSet() attribute.Set

+ type Middleware = middleware.Middleware

+ type OperationName = string

+ const HealthzOperation

+ type Option interface

+ func WithMeterProvider(provider metric.MeterProvider) Option

+ func WithTracerProvider(provider trace.TracerProvider) Option

+ type Route struct

+ func (r Route) Args() []string

+ func (r Route) Name() string

+ func (r Route) OperationID() string

+ func (r Route) PathPattern() string

+ func (r Route) Summary() string

+ type Server struct

+ func NewServer(h Handler, opts ...ServerOption) (*Server, error)

+ func (s *Server) FindPath(method string, u *url.URL) (r Route, _ bool)

+ func (s *Server) FindRoute(method, path string) (Route, bool)

+ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type ServerOption interface

+ func WithErrorHandler(h ErrorHandler) ServerOption

+ func WithMaxMultipartMemory(max int64) ServerOption

+ func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) ServerOption

+ func WithMiddleware(m ...Middleware) ServerOption

+ func WithNotFound(notFound http.HandlerFunc) ServerOption

+ func WithPathPrefix(prefix string) ServerOption