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: 24 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 AnyArrayParamOK 

type AnyArrayParamOK struct {
	Count OptInt `json:"count"`
}

func (*AnyArrayParamOK) Decode 

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

Decode decodes AnyArrayParamOK from json.

func (*AnyArrayParamOK) Encode 

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

Encode implements json.Marshaler.

func (*AnyArrayParamOK) GetCount 

func (s *AnyArrayParamOK) GetCount() OptInt

GetCount returns the value of Count.

func (*AnyArrayParamOK) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AnyArrayParamOK) SetCount 

func (s *AnyArrayParamOK) SetCount(val OptInt)

SetCount sets the value of Count.

func (*AnyArrayParamOK) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type AnyArrayParamParams 

type AnyArrayParamParams struct {
	// Array parameter with any type items.
	Items []any `json:",omitempty"`
}

AnyArrayParamParams is parameters of anyArrayParam operation.

type AnyParamsOK 

type AnyParamsOK struct {
	Echo AnyParamsOKEcho `json:"echo"`
}

func (*AnyParamsOK) Decode 

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

Decode decodes AnyParamsOK from json.

func (*AnyParamsOK) Encode 

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

Encode implements json.Marshaler.

func (*AnyParamsOK) GetEcho 

func (s *AnyParamsOK) GetEcho() AnyParamsOKEcho

GetEcho returns the value of Echo.

func (*AnyParamsOK) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AnyParamsOK) SetEcho 

func (s *AnyParamsOK) SetEcho(val AnyParamsOKEcho)

SetEcho sets the value of Echo.

func (*AnyParamsOK) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type AnyParamsOKEcho 

type AnyParamsOKEcho struct {
	PathParam   string    `json:"pathParam"`
	QueryParam  OptString `json:"queryParam"`
	HeaderParam OptString `json:"headerParam"`
	CookieParam OptString `json:"cookieParam"`
}

func (*AnyParamsOKEcho) Decode 

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

Decode decodes AnyParamsOKEcho from json.

func (*AnyParamsOKEcho) Encode 

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

Encode implements json.Marshaler.

func (*AnyParamsOKEcho) GetCookieParam 

func (s *AnyParamsOKEcho) GetCookieParam() OptString

GetCookieParam returns the value of CookieParam.

func (*AnyParamsOKEcho) GetHeaderParam 

func (s *AnyParamsOKEcho) GetHeaderParam() OptString

GetHeaderParam returns the value of HeaderParam.

func (*AnyParamsOKEcho) GetPathParam 

func (s *AnyParamsOKEcho) GetPathParam() string

GetPathParam returns the value of PathParam.

func (*AnyParamsOKEcho) GetQueryParam 

func (s *AnyParamsOKEcho) GetQueryParam() OptString

GetQueryParam returns the value of QueryParam.

func (*AnyParamsOKEcho) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AnyParamsOKEcho) SetCookieParam 

func (s *AnyParamsOKEcho) SetCookieParam(val OptString)

SetCookieParam sets the value of CookieParam.

func (*AnyParamsOKEcho) SetHeaderParam 

func (s *AnyParamsOKEcho) SetHeaderParam(val OptString)

SetHeaderParam sets the value of HeaderParam.

func (*AnyParamsOKEcho) SetPathParam 

func (s *AnyParamsOKEcho) SetPathParam(val string)

SetPathParam sets the value of PathParam.

func (*AnyParamsOKEcho) SetQueryParam 

func (s *AnyParamsOKEcho) SetQueryParam(val OptString)

SetQueryParam sets the value of QueryParam.

func (*AnyParamsOKEcho) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type AnyParamsParams 

type AnyParamsParams struct {
	// Path parameter with no type specified.
	PathParam any
	// Query parameter with no type specified.
	QueryParam any
	// Header parameter with no type specified.
	XHeaderParam any
	// Cookie parameter with no type specified.
	CookieParam any
}

AnyParamsParams is parameters of anyParams operation.

type AnyParamsRequiredOK 

type AnyParamsRequiredOK struct {
	Received bool `json:"received"`
}

func (*AnyParamsRequiredOK) Decode 

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

Decode decodes AnyParamsRequiredOK from json.

func (*AnyParamsRequiredOK) Encode 

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

Encode implements json.Marshaler.

func (*AnyParamsRequiredOK) GetReceived 

func (s *AnyParamsRequiredOK) GetReceived() bool

GetReceived returns the value of Received.

func (*AnyParamsRequiredOK) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AnyParamsRequiredOK) SetReceived 

func (s *AnyParamsRequiredOK) SetReceived(val bool)

SetReceived sets the value of Received.

func (*AnyParamsRequiredOK) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type AnyParamsRequiredParams 

type AnyParamsRequiredParams struct {
	PathParam    any
	QueryParam   any
	XHeaderParam any
}

AnyParamsRequiredParams is parameters of anyParamsRequired 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) AnyArrayParam 

func (c *Client) AnyArrayParam(ctx context.Context, params AnyArrayParamParams) (*AnyArrayParamOK, error)

AnyArrayParam invokes anyArrayParam operation.

Test array of any type.

GET /any/array

func (*Client) AnyParams 

func (c *Client) AnyParams(ctx context.Context, params AnyParamsParams) (*AnyParamsOK, error)

AnyParams invokes anyParams operation.

Test all parameter locations with any type.

GET /any/{pathParam}

func (*Client) AnyParamsRequired 

func (c *Client) AnyParamsRequired(ctx context.Context, params AnyParamsRequiredParams) (*AnyParamsRequiredOK, error)

AnyParamsRequired invokes anyParamsRequired operation.

Test required any type parameters.

GET /any/required/{pathParam}

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 {
	// AnyArrayParam implements anyArrayParam operation.
	//
	// Test array of any type.
	//
	// GET /any/array
	AnyArrayParam(ctx context.Context, params AnyArrayParamParams) (*AnyArrayParamOK, error)
	// AnyParams implements anyParams operation.
	//
	// Test all parameter locations with any type.
	//
	// GET /any/{pathParam}
	AnyParams(ctx context.Context, params AnyParamsParams) (*AnyParamsOK, error)
	// AnyParamsRequired implements anyParamsRequired operation.
	//
	// Test required any type parameters.
	//
	// GET /any/required/{pathParam}
	AnyParamsRequired(ctx context.Context, params AnyParamsRequiredParams) (*AnyParamsRequiredOK, error)
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	// AnyArrayParam invokes anyArrayParam operation.
	//
	// Test array of any type.
	//
	// GET /any/array
	AnyArrayParam(ctx context.Context, params AnyArrayParamParams) (*AnyArrayParamOK, error)
	// AnyParams invokes anyParams operation.
	//
	// Test all parameter locations with any type.
	//
	// GET /any/{pathParam}
	AnyParams(ctx context.Context, params AnyParamsParams) (*AnyParamsOK, error)
	// AnyParamsRequired invokes anyParamsRequired operation.
	//
	// Test required any type parameters.
	//
	// GET /any/required/{pathParam}
	AnyParamsRequired(ctx context.Context, params AnyParamsRequiredParams) (*AnyParamsRequiredOK, 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 (
	AnyArrayParamOperation     OperationName = "AnyArrayParam"
	AnyParamsOperation         OperationName = "AnyParams"
	AnyParamsRequiredOperation OperationName = "AnyParamsRequired"
)

type OptInt 

type OptInt struct {
	Value int
	Set   bool
}

OptInt is optional int.

func NewOptInt 

func NewOptInt(v int) OptInt

NewOptInt returns new OptInt with value set to v.

func (*OptInt) Decode 

func (o *OptInt) Decode(d *jx.Decoder) error

Decode decodes int from json.

func (OptInt) Encode 

func (o OptInt) Encode(e *jx.Encoder)

Encode encodes int as json.

func (OptInt) Get 

func (o OptInt) Get() (v int, ok bool)

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

func (OptInt) IsSet 

func (o OptInt) IsSet() bool

IsSet returns true if OptInt was set.

func (OptInt) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (OptInt) Or 

func (o OptInt) Or(d int) int

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

func (*OptInt) Reset 

func (o *OptInt) Reset()

Reset unsets value.

func (*OptInt) SetTo 

func (o *OptInt) SetTo(v int)

SetTo sets value to v.

func (*OptInt) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

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

func (o *OptString) Decode(d *jx.Decoder) error

Decode decodes string from json.

func (OptString) Encode 

func (o OptString) Encode(e *jx.Encoder)

Encode encodes string as json.

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

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

MarshalJSON implements stdjson.Marshaler.

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.

func (*OptString) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

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

func (UnimplementedHandler) AnyArrayParam(ctx context.Context, params AnyArrayParamParams) (r *AnyArrayParamOK, _ error)

AnyArrayParam implements anyArrayParam operation.

Test array of any type.

GET /any/array

func (UnimplementedHandler) AnyParams 

func (UnimplementedHandler) AnyParams(ctx context.Context, params AnyParamsParams) (r *AnyParamsOK, _ error)

AnyParams implements anyParams operation.

Test all parameter locations with any type.

GET /any/{pathParam}

func (UnimplementedHandler) AnyParamsRequired 

func (UnimplementedHandler) AnyParamsRequired(ctx context.Context, params AnyParamsRequiredParams) (r *AnyParamsRequiredOK, _ error)

AnyParamsRequired implements anyParamsRequired operation.

Test required any type parameters.

GET /any/required/{pathParam}

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.