api

package
v1.19.0 Latest Latest
Warning

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

 Go to latest Published: Feb 11, 2026 License: Apache-2.0 Imports: 23 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 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) GetTest 

func (c *Client) GetTest(ctx context.Context) (ObjectEnum, error)

GetTest invokes getTest operation.

GET /test

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 {
	// GetTest implements getTest operation.
	//
	// GET /test
	GetTest(ctx context.Context) (ObjectEnum, error)
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	// GetTest invokes getTest operation.
	//
	// GET /test
	GetTest(ctx context.Context) (ObjectEnum, 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 ObjectEnum 

type ObjectEnum struct {
	Type          ObjectEnumType // switch on this field
	ObjectEnumFoo ObjectEnumFoo
	ObjectEnumBar ObjectEnumBar
	ObjectEnumBaz ObjectEnumBaz
}

An enum of specific object values. Ref: #/components/schemas/ObjectEnum ObjectEnum represents sum type.

func NewObjectEnumBarObjectEnum 

func NewObjectEnumBarObjectEnum(v ObjectEnumBar) ObjectEnum

NewObjectEnumBarObjectEnum returns new ObjectEnum from ObjectEnumBar.

func NewObjectEnumBazObjectEnum 

func NewObjectEnumBazObjectEnum(v ObjectEnumBaz) ObjectEnum

NewObjectEnumBazObjectEnum returns new ObjectEnum from ObjectEnumBaz.

func NewObjectEnumFooObjectEnum 

func NewObjectEnumFooObjectEnum(v ObjectEnumFoo) ObjectEnum

NewObjectEnumFooObjectEnum returns new ObjectEnum from ObjectEnumFoo.

func (*ObjectEnum) Decode 

func (s *ObjectEnum) Decode(d *jx.Decoder) error

Decode decodes ObjectEnum from json.

func (ObjectEnum) Encode 

func (s ObjectEnum) Encode(e *jx.Encoder)

Encode encodes ObjectEnum as json.

func (ObjectEnum) GetObjectEnumBar 

func (s ObjectEnum) GetObjectEnumBar() (v ObjectEnumBar, ok bool)

GetObjectEnumBar returns ObjectEnumBar and true boolean if ObjectEnum is ObjectEnumBar.

func (ObjectEnum) GetObjectEnumBaz 

func (s ObjectEnum) GetObjectEnumBaz() (v ObjectEnumBaz, ok bool)

GetObjectEnumBaz returns ObjectEnumBaz and true boolean if ObjectEnum is ObjectEnumBaz.

func (ObjectEnum) GetObjectEnumFoo 

func (s ObjectEnum) GetObjectEnumFoo() (v ObjectEnumFoo, ok bool)

GetObjectEnumFoo returns ObjectEnumFoo and true boolean if ObjectEnum is ObjectEnumFoo.

func (ObjectEnum) IsObjectEnumBar 

func (s ObjectEnum) IsObjectEnumBar() bool

IsObjectEnumBar reports whether ObjectEnum is ObjectEnumBar.

func (ObjectEnum) IsObjectEnumBaz 

func (s ObjectEnum) IsObjectEnumBaz() bool

IsObjectEnumBaz reports whether ObjectEnum is ObjectEnumBaz.

func (ObjectEnum) IsObjectEnumFoo 

func (s ObjectEnum) IsObjectEnumFoo() bool

IsObjectEnumFoo reports whether ObjectEnum is ObjectEnumFoo.

func (ObjectEnum) MarshalJSON 

func (s ObjectEnum) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ObjectEnum) SetObjectEnumBar 

func (s *ObjectEnum) SetObjectEnumBar(v ObjectEnumBar)

SetObjectEnumBar sets ObjectEnum to ObjectEnumBar.

func (*ObjectEnum) SetObjectEnumBaz 

func (s *ObjectEnum) SetObjectEnumBaz(v ObjectEnumBaz)

SetObjectEnumBaz sets ObjectEnum to ObjectEnumBaz.

func (*ObjectEnum) SetObjectEnumFoo 

func (s *ObjectEnum) SetObjectEnumFoo(v ObjectEnumFoo)

SetObjectEnumFoo sets ObjectEnum to ObjectEnumFoo.

func (*ObjectEnum) UnmarshalJSON 

func (s *ObjectEnum) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ObjectEnumBar 

type ObjectEnumBar struct {
	Type  string `json:"type"`
	Value int64  `json:"value"`
}

func (*ObjectEnumBar) Decode 

func (s *ObjectEnumBar) Decode(d *jx.Decoder) error

Decode decodes ObjectEnumBar from json.

func (*ObjectEnumBar) Encode 

func (s *ObjectEnumBar) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ObjectEnumBar) GetType 

func (s *ObjectEnumBar) GetType() string

GetType returns the value of Type.

func (*ObjectEnumBar) GetValue 

func (s *ObjectEnumBar) GetValue() int64

GetValue returns the value of Value.

func (*ObjectEnumBar) MarshalJSON 

func (s *ObjectEnumBar) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ObjectEnumBar) SetType 

func (s *ObjectEnumBar) SetType(val string)

SetType sets the value of Type.

func (*ObjectEnumBar) SetValue 

func (s *ObjectEnumBar) SetValue(val int64)

SetValue sets the value of Value.

func (*ObjectEnumBar) UnmarshalJSON 

func (s *ObjectEnumBar) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ObjectEnumBaz 

type ObjectEnumBaz struct {
	Type  string `json:"type"`
	Value int64  `json:"value"`
}

func (*ObjectEnumBaz) Decode 

func (s *ObjectEnumBaz) Decode(d *jx.Decoder) error

Decode decodes ObjectEnumBaz from json.

func (*ObjectEnumBaz) Encode 

func (s *ObjectEnumBaz) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ObjectEnumBaz) GetType 

func (s *ObjectEnumBaz) GetType() string

GetType returns the value of Type.

func (*ObjectEnumBaz) GetValue 

func (s *ObjectEnumBaz) GetValue() int64

GetValue returns the value of Value.

func (*ObjectEnumBaz) MarshalJSON 

func (s *ObjectEnumBaz) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ObjectEnumBaz) SetType 

func (s *ObjectEnumBaz) SetType(val string)

SetType sets the value of Type.

func (*ObjectEnumBaz) SetValue 

func (s *ObjectEnumBaz) SetValue(val int64)

SetValue sets the value of Value.

func (*ObjectEnumBaz) UnmarshalJSON 

func (s *ObjectEnumBaz) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ObjectEnumFoo 

type ObjectEnumFoo struct {
	Type  string `json:"type"`
	Value int64  `json:"value"`
}

func (*ObjectEnumFoo) Decode 

func (s *ObjectEnumFoo) Decode(d *jx.Decoder) error

Decode decodes ObjectEnumFoo from json.

func (*ObjectEnumFoo) Encode 

func (s *ObjectEnumFoo) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ObjectEnumFoo) GetType 

func (s *ObjectEnumFoo) GetType() string

GetType returns the value of Type.

func (*ObjectEnumFoo) GetValue 

func (s *ObjectEnumFoo) GetValue() int64

GetValue returns the value of Value.

func (*ObjectEnumFoo) MarshalJSON 

func (s *ObjectEnumFoo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ObjectEnumFoo) SetType 

func (s *ObjectEnumFoo) SetType(val string)

SetType sets the value of Type.

func (*ObjectEnumFoo) SetValue 

func (s *ObjectEnumFoo) SetValue(val int64)

SetValue sets the value of Value.

func (*ObjectEnumFoo) UnmarshalJSON 

func (s *ObjectEnumFoo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ObjectEnumType 

type ObjectEnumType string

ObjectEnumType is oneOf type of ObjectEnum. 

const (
	ObjectEnumFooObjectEnum ObjectEnumType = "ObjectEnumFoo"
	ObjectEnumBarObjectEnum ObjectEnumType = "ObjectEnumBar"
	ObjectEnumBazObjectEnum ObjectEnumType = "ObjectEnumBaz"
)

Possible values for ObjectEnumType.

type OperationName 

type OperationName = string

OperationName is the ogen operation name 

const (
	GetTestOperation OperationName = "GetTest"
)

type Option 

type Option interface {
	ServerOption
	ClientOption
}

Option is config option.

func WithAttributes 

func WithAttributes(attributes ...attribute.KeyValue) Option

WithAttributes specifies default otel attributes.

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) OperationGroup 

func (r Route) OperationGroup() string

OperationGroup returns the x-ogen-operation-group value.

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) GetTest 

func (UnimplementedHandler) GetTest(ctx context.Context) (r ObjectEnum, _ error)

GetTest implements getTest operation.

GET /test

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.