api

package
v1.10.0 Latest Latest
Warning

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

 Go to latest Published: Feb 7, 2025 License: Apache-2.0 Imports: 20 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 AliveFlexData 

type AliveFlexData struct {
	HelloWorld      OptString `json:"hello_world"`
	AdditionalProps AliveFlexDataAdditional
	// Pattern: "^pat-.*".
	Pattern0Props AliveFlexDataPattern0
}

func (*AliveFlexData) DecodeURI 

func (s *AliveFlexData) DecodeURI(d uri.Decoder) error

DecodeURI decodes AliveFlexData from URI form.

func (*AliveFlexData) EncodeURI 

func (s *AliveFlexData) EncodeURI(e uri.Encoder) error

EncodeURI encodes AliveFlexData as URI form.

func (*AliveFlexData) GetAdditionalProps 

func (s *AliveFlexData) GetAdditionalProps() AliveFlexDataAdditional

GetAdditionalProps returns the value of AdditionalProps.

func (*AliveFlexData) GetHelloWorld 

func (s *AliveFlexData) GetHelloWorld() OptString

GetHelloWorld returns the value of HelloWorld.

func (*AliveFlexData) GetPattern0Props 

func (s *AliveFlexData) GetPattern0Props() AliveFlexDataPattern0

GetPattern0Props returns the value of Pattern0Props.

func (*AliveFlexData) SetAdditionalProps 

func (s *AliveFlexData) SetAdditionalProps(val AliveFlexDataAdditional)

SetAdditionalProps sets the value of AdditionalProps.

func (*AliveFlexData) SetHelloWorld 

func (s *AliveFlexData) SetHelloWorld(val OptString)

SetHelloWorld sets the value of HelloWorld.

func (*AliveFlexData) SetPattern0Props 

func (s *AliveFlexData) SetPattern0Props(val AliveFlexDataPattern0)

SetPattern0Props sets the value of Pattern0Props.

type AliveFlexDataAdditional 

type AliveFlexDataAdditional map[string]string

type AliveFlexDataPattern0 

type AliveFlexDataPattern0 map[string]string

type AliveOK 

type AliveOK struct{}

AliveOK is response for Alive operation.

type AliveParams 

type AliveParams struct {
	FlexData OptAliveFlexData
}

AliveParams is parameters of alive operation.

type Client 

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

Client implements OAS client.

func NewClient 

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

NewClient initializes new Client defined by OAS.

func (*Client) Alive 

func (c *Client) Alive(ctx context.Context, params AliveParams) error

Alive invokes alive operation.

GET /api/alive

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 ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type Handler 

type Handler interface {
	// Alive implements alive operation.
	//
	// GET /api/alive
	Alive(ctx context.Context, params AliveParams) error
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	// Alive invokes alive operation.
	//
	// GET /api/alive
	Alive(ctx context.Context, params AliveParams) error
}

Invoker invokes operations described by OpenAPI v3 specification.

type Labeler 

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

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

func LabelerFromContext 

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 

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

Add attributes to the Labeler.

func (*Labeler) AttributeSet 

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 

type OperationName = string

OperationName is the ogen operation name 

const (
	AliveOperation OperationName = "Alive"
)

type OptAliveFlexData 

type OptAliveFlexData struct {
	Value AliveFlexData
	Set   bool
}

OptAliveFlexData is optional AliveFlexData.

func NewOptAliveFlexData 

func NewOptAliveFlexData(v AliveFlexData) OptAliveFlexData

NewOptAliveFlexData returns new OptAliveFlexData with value set to v.

func (OptAliveFlexData) Get 

func (o OptAliveFlexData) Get() (v AliveFlexData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptAliveFlexData) IsSet 

func (o OptAliveFlexData) IsSet() bool

IsSet returns true if OptAliveFlexData was set.

func (OptAliveFlexData) Or 

func (o OptAliveFlexData) Or(d AliveFlexData) AliveFlexData

Or returns value if set, or given parameter if does not.

func (*OptAliveFlexData) Reset 

func (o *OptAliveFlexData) Reset()

Reset unsets value.

func (*OptAliveFlexData) SetTo 

func (o *OptAliveFlexData) SetTo(v AliveFlexData)

SetTo sets value to v.

type OptString 

type OptString struct {
	Value string
	Set   bool
}

OptString is optional string.

func NewOptString 

func NewOptString(v string) OptString

NewOptString returns new OptString with value set to v.

func (OptString) Get 

func (o OptString) Get() (v string, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptString) IsSet 

func (o OptString) IsSet() bool

IsSet returns true if OptString was set.

func (OptString) Or 

func (o OptString) Or(d string) string

Or returns value if set, or given parameter if does not.

func (*OptString) Reset 

func (o *OptString) Reset()

Reset unsets value.

func (*OptString) SetTo 

func (o *OptString) SetTo(v string)

SetTo sets value to v.

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 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 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, 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) Alive 

func (UnimplementedHandler) Alive(ctx context.Context, params AliveParams) error

Alive implements alive operation.

GET /api/alive

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.