Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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.8.1

Dec 3, 2024

v1.8.0

Dec 1, 2024

v1.7.0

Nov 25, 2024

Changes in this version

+ type OperationName = string

+ const CustomSecurityOperation

+ const DisjointSecurityOperation

+ const IntersectSecurityOperation

+ const OptionalSecurityOperation

v1.6.0

Oct 25, 2024

v1.6.0-alpha.0

Oct 25, 2024

v1.5.0

Oct 16, 2024

v1.4.1

Sep 10, 2024

v1.4.0

Sep 5, 2024

v1.3.0

Aug 7, 2024

v1.2.2

Jun 23, 2024

v1.2.1

May 28, 2024

v1.2.0

May 24, 2024

v1.1.1

May 20, 2024

v1.1.0

Apr 17, 2024

Changes in this version

+ type Labeler struct

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

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

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

v1.0.0

Mar 13, 2024

v0

v0.83.0

Mar 11, 2024

Changes in this version

+ func WithServerURL(ctx context.Context, u *url.URL) context.Context

+ type BasicAuth struct

+ Password string

+ Username string

+ func (s *BasicAuth) GetPassword() string

+ func (s *BasicAuth) GetUsername() string

+ func (s *BasicAuth) SetPassword(val string)

+ func (s *BasicAuth) SetUsername(val string)

+ type BearerToken struct

+ Token string

+ func (s *BearerToken) GetToken() string

+ func (s *BearerToken) SetToken(val string)

+ type Client struct

+ func NewClient(serverURL string, sec SecuritySource, opts ...ClientOption) (*Client, error)

+ func (c *Client) CustomSecurity(ctx context.Context) error

+ func (c *Client) DisjointSecurity(ctx context.Context) error

+ func (c *Client) IntersectSecurity(ctx context.Context) error

+ func (c *Client) OptionalSecurity(ctx context.Context) error

+ type ClientOption interface

+ func WithClient(client ht.Client) ClientOption

+ type CookieKey struct

+ APIKey string

+ func (s *CookieKey) GetAPIKey() string

+ func (s *CookieKey) SetAPIKey(val string)

+ type CustomSecurityOK struct

+ type DisjointSecurityOK struct

+ type ErrorHandler = ogenerrors.ErrorHandler

+ type Handler interface

+ CustomSecurity func(ctx context.Context) error

+ DisjointSecurity func(ctx context.Context) error

+ IntersectSecurity func(ctx context.Context) error

+ OptionalSecurity func(ctx context.Context) error

+ type HeaderKey struct

+ APIKey string

+ func (s *HeaderKey) GetAPIKey() string

+ func (s *HeaderKey) SetAPIKey(val string)

+ type IntersectSecurityOK struct

+ type Invoker interface

+ CustomSecurity func(ctx context.Context) error

+ DisjointSecurity func(ctx context.Context) error

+ IntersectSecurity func(ctx context.Context) error

+ OptionalSecurity func(ctx context.Context) error

+ type Middleware = middleware.Middleware

+ type Option interface

+ func WithMeterProvider(provider metric.MeterProvider) Option

+ func WithTracerProvider(provider trace.TracerProvider) Option

+ type OptionalSecurityOK struct

+ type QueryKey struct

+ APIKey string

+ func (s *QueryKey) GetAPIKey() string

+ func (s *QueryKey) SetAPIKey(val string)

+ 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 SecurityHandler interface

+ HandleBasicAuth func(ctx context.Context, operationName string, t BasicAuth) (context.Context, error)

+ HandleBearerToken func(ctx context.Context, operationName string, t BearerToken) (context.Context, error)

+ HandleCookieKey func(ctx context.Context, operationName string, t CookieKey) (context.Context, error)

+ HandleCustom func(ctx context.Context, operationName string, req *http.Request) (context.Context, error)

+ HandleHeaderKey func(ctx context.Context, operationName string, t HeaderKey) (context.Context, error)

+ HandleQueryKey func(ctx context.Context, operationName string, t QueryKey) (context.Context, error)

+ type SecuritySource interface

+ BasicAuth func(ctx context.Context, operationName string, client *Client) (BasicAuth, error)

+ BearerToken func(ctx context.Context, operationName string, client *Client) (BearerToken, error)

+ CookieKey func(ctx context.Context, operationName string, client *Client) (CookieKey, error)

+ Custom func(ctx context.Context, operationName string, req *http.Request, client *Client) error

+ HeaderKey func(ctx context.Context, operationName string, client *Client) (HeaderKey, error)

+ QueryKey func(ctx context.Context, operationName string, client *Client) (QueryKey, error)

+ type Server struct

+ func NewServer(h Handler, sec SecurityHandler, 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

+ type UnimplementedHandler struct

+ func (UnimplementedHandler) CustomSecurity(ctx context.Context) error

+ func (UnimplementedHandler) DisjointSecurity(ctx context.Context) error

+ func (UnimplementedHandler) IntersectSecurity(ctx context.Context) error

+ func (UnimplementedHandler) OptionalSecurity(ctx context.Context) error