api

package
v1.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 3, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithServerURL 

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

WithServerURL sets context key to override server URL.

Types

type BasicAuth 

type BasicAuth struct {
	Username string
	Password string
}

func (*BasicAuth) GetPassword 

func (s *BasicAuth) GetPassword() string

GetPassword returns the value of Password.

func (*BasicAuth) GetUsername 

func (s *BasicAuth) GetUsername() string

GetUsername returns the value of Username.

func (*BasicAuth) SetPassword 

func (s *BasicAuth) SetPassword(val string)

SetPassword sets the value of Password.

func (*BasicAuth) SetUsername 

func (s *BasicAuth) SetUsername(val string)

SetUsername sets the value of Username.

type BearerToken 

type BearerToken struct {
	Token string
}

func (*BearerToken) GetToken 

func (s *BearerToken) GetToken() string

GetToken returns the value of Token.

func (*BearerToken) SetToken 

func (s *BearerToken) SetToken(val string)

SetToken sets the value of Token.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client implements OAS client.

func NewClient 

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

NewClient initializes new Client defined by OAS.

func (*Client) CustomSecurity 

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

CustomSecurity invokes customSecurity operation.

GET /customSecurity

func (*Client) DisjointSecurity 

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

DisjointSecurity invokes disjointSecurity operation.

GET /disjointSecurity

func (*Client) IntersectSecurity 

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

IntersectSecurity invokes intersectSecurity operation.

GET /intersectSecurity

func (*Client) OptionalSecurity 

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

OptionalSecurity invokes optionalSecurity operation.

GET /optionalSecurity

type ClientOption 

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption is client config option.

func WithClient 

func WithClient(client ht.Client) ClientOption

WithClient specifies http client to use.

type CookieKey 

type CookieKey struct {
	APIKey string
}

func (*CookieKey) GetAPIKey 

func (s *CookieKey) GetAPIKey() string

GetAPIKey returns the value of APIKey.

func (*CookieKey) SetAPIKey 

func (s *CookieKey) SetAPIKey(val string)

SetAPIKey sets the value of APIKey.

type CustomSecurityOK 

type CustomSecurityOK struct{}

CustomSecurityOK is response for CustomSecurity operation.

type DisjointSecurityOK 

type DisjointSecurityOK struct{}

DisjointSecurityOK is response for DisjointSecurity operation.

type ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type Handler 

type Handler interface {
	// CustomSecurity implements customSecurity operation.
	//
	// GET /customSecurity
	CustomSecurity(ctx context.Context) error
	// DisjointSecurity implements disjointSecurity operation.
	//
	// GET /disjointSecurity
	DisjointSecurity(ctx context.Context) error
	// IntersectSecurity implements intersectSecurity operation.
	//
	// GET /intersectSecurity
	IntersectSecurity(ctx context.Context) error
	// OptionalSecurity implements optionalSecurity operation.
	//
	// GET /optionalSecurity
	OptionalSecurity(ctx context.Context) error
}

Handler handles operations described by OpenAPI v3 specification.

type HeaderKey 

type HeaderKey struct {
	APIKey string
}

func (*HeaderKey) GetAPIKey 

func (s *HeaderKey) GetAPIKey() string

GetAPIKey returns the value of APIKey.

func (*HeaderKey) SetAPIKey 

func (s *HeaderKey) SetAPIKey(val string)

SetAPIKey sets the value of APIKey.

type IntersectSecurityOK 

type IntersectSecurityOK struct{}

IntersectSecurityOK is response for IntersectSecurity operation.

type Invoker 

type Invoker interface {
	// CustomSecurity invokes customSecurity operation.
	//
	// GET /customSecurity
	CustomSecurity(ctx context.Context) error
	// DisjointSecurity invokes disjointSecurity operation.
	//
	// GET /disjointSecurity
	DisjointSecurity(ctx context.Context) error
	// IntersectSecurity invokes intersectSecurity operation.
	//
	// GET /intersectSecurity
	IntersectSecurity(ctx context.Context) error
	// OptionalSecurity invokes optionalSecurity operation.
	//
	// GET /optionalSecurity
	OptionalSecurity(ctx context.Context) error
}

Invoker invokes operations described by OpenAPI v3 specification.

type Labeler added in v1.1.0 

type Labeler struct {
	// contains filtered or unexported fields
}

Labeler is used to allow adding custom attributes to the server request metrics.

func LabelerFromContext added in v1.1.0 

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

LabelerFromContext retrieves the Labeler from the provided context, if present.

If no Labeler was found in the provided context a new, empty Labeler is returned and the second return value is false. In this case it is safe to use the Labeler but any attributes added to it will not be used.

func (*Labeler) Add added in v1.1.0 

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

Add attributes to the Labeler.

func (*Labeler) AttributeSet added in v1.1.0 

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

AttributeSet returns the attributes added to the Labeler as an attribute.Set.

type Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

type OperationName added in v1.7.0 

type OperationName = string

OperationName is the ogen operation name 

const (
	CustomSecurityOperation    OperationName = "CustomSecurity"
	DisjointSecurityOperation  OperationName = "DisjointSecurity"
	IntersectSecurityOperation OperationName = "IntersectSecurity"
	OptionalSecurityOperation  OperationName = "OptionalSecurity"
)

type Option 

type Option interface {
	ServerOption
	ClientOption
}

Option is config option.

func WithMeterProvider 

func WithMeterProvider(provider metric.MeterProvider) Option

WithMeterProvider specifies a meter provider to use for creating a meter.

If none is specified, the otel.GetMeterProvider() is used.

func WithTracerProvider 

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer.

If none is specified, the global provider is used.

type OptionalSecurityOK 

type OptionalSecurityOK struct{}

OptionalSecurityOK is response for OptionalSecurity operation.

type QueryKey 

type QueryKey struct {
	APIKey string
}

func (*QueryKey) GetAPIKey 

func (s *QueryKey) GetAPIKey() string

GetAPIKey returns the value of APIKey.

func (*QueryKey) SetAPIKey 

func (s *QueryKey) SetAPIKey(val string)

SetAPIKey sets the value of APIKey.

type Route 

type Route struct {
	// contains filtered or unexported fields
}

Route is route object.

func (Route) Args 

func (r Route) Args() []string

Args returns parsed arguments.

func (Route) Name 

func (r Route) Name() string

Name returns ogen operation name.

It is guaranteed to be unique and not empty.

func (Route) OperationID 

func (r Route) OperationID() string

OperationID returns OpenAPI operationId.

func (Route) PathPattern 

func (r Route) PathPattern() string

PathPattern returns OpenAPI path.

func (Route) Summary 

func (r Route) Summary() string

Summary returns OpenAPI summary.

type SecurityHandler 

type SecurityHandler interface {
	// HandleBasicAuth handles basicAuth security.
	HandleBasicAuth(ctx context.Context, operationName OperationName, t BasicAuth) (context.Context, error)
	// HandleBearerToken handles bearerToken security.
	HandleBearerToken(ctx context.Context, operationName OperationName, t BearerToken) (context.Context, error)
	// HandleCookieKey handles cookieKey security.
	HandleCookieKey(ctx context.Context, operationName OperationName, t CookieKey) (context.Context, error)
	// HandleCustom handles custom security.
	HandleCustom(ctx context.Context, operationName OperationName, req *http.Request) (context.Context, error)
	// HandleHeaderKey handles headerKey security.
	HandleHeaderKey(ctx context.Context, operationName OperationName, t HeaderKey) (context.Context, error)
	// HandleQueryKey handles queryKey security.
	HandleQueryKey(ctx context.Context, operationName OperationName, t QueryKey) (context.Context, error)
}

SecurityHandler is handler for security parameters.

type SecuritySource 

type SecuritySource interface {
	// BasicAuth provides basicAuth security value.
	BasicAuth(ctx context.Context, operationName OperationName, client *Client) (BasicAuth, error)
	// BearerToken provides bearerToken security value.
	BearerToken(ctx context.Context, operationName OperationName, client *Client) (BearerToken, error)
	// CookieKey provides cookieKey security value.
	CookieKey(ctx context.Context, operationName OperationName, client *Client) (CookieKey, error)
	// Custom provides custom security value.
	Custom(ctx context.Context, operationName OperationName, req *http.Request, client *Client) error
	// HeaderKey provides headerKey security value.
	HeaderKey(ctx context.Context, operationName OperationName, client *Client) (HeaderKey, error)
	// QueryKey provides queryKey security value.
	QueryKey(ctx context.Context, operationName OperationName, client *Client) (QueryKey, error)
}

SecuritySource is provider of security values (tokens, passwords, etc.).

type Server 

type Server struct {
	// contains filtered or unexported fields
}

Server implements http server based on OpenAPI v3 specification and calls Handler to handle requests.

func NewServer 

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

NewServer creates new Server.

func (*Server) FindPath 

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

FindPath finds Route for given method and URL.

func (*Server) FindRoute 

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

FindRoute finds Route for given method and path.

Note: this method does not unescape path or handle reserved characters in path properly. Use FindPath instead.

func (*Server) ServeHTTP 

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

ServeHTTP serves http request as defined by OpenAPI v3 specification, calling handler that matches the path or returning not found error.

type ServerOption 

type ServerOption interface {
	// contains filtered or unexported methods
}

ServerOption is server config option.

func WithErrorHandler 

func WithErrorHandler(h ErrorHandler) ServerOption

WithErrorHandler specifies error handler to use.

func WithMaxMultipartMemory 

func WithMaxMultipartMemory(max int64) ServerOption

WithMaxMultipartMemory specifies limit of memory for storing file parts. File parts which can't be stored in memory will be stored on disk in temporary files.

func WithMethodNotAllowed 

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

WithMethodNotAllowed specifies Method Not Allowed handler to use.

func WithMiddleware 

func WithMiddleware(m ...Middleware) ServerOption

WithMiddleware specifies middlewares to use.

func WithNotFound 

func WithNotFound(notFound http.HandlerFunc) ServerOption

WithNotFound specifies Not Found handler to use.

func WithPathPrefix 

func WithPathPrefix(prefix string) ServerOption

WithPathPrefix specifies server path prefix.

type UnimplementedHandler 

type UnimplementedHandler struct{}

UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.

func (UnimplementedHandler) CustomSecurity 

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

CustomSecurity implements customSecurity operation.

GET /customSecurity

func (UnimplementedHandler) DisjointSecurity 

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

DisjointSecurity implements disjointSecurity operation.

GET /disjointSecurity

func (UnimplementedHandler) IntersectSecurity 

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

IntersectSecurity implements intersectSecurity operation.

GET /intersectSecurity

func (UnimplementedHandler) OptionalSecurity 

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

OptionalSecurity implements optionalSecurity operation.

GET /optionalSecurity

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.