api

package
v0.0.0-...-2912eac Latest Latest
Warning

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

 Go to latest Published: Apr 4, 2024 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Overview

Code generated by ogen, DO NOT EDIT.

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

func (c *Client) GetHealth(ctx context.Context, params GetHealthParams) (GetHealthRes, error)

GetHealth invokes getHealth operation.

Health.

GET /health

func (*Client) PostHealth 

func (c *Client) PostHealth(ctx context.Context, request *HealthRequestSchema) (PostHealthRes, error)

PostHealth invokes postHealth operation.

Health.

POST /health

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 ErrorResponseSchema 

type ErrorResponseSchema struct {
	Message string `json:"message"`
}

Ref: #/components/schemas/ErrorResponseSchema

func (*ErrorResponseSchema) Decode 

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

Decode decodes ErrorResponseSchema from json.

func (*ErrorResponseSchema) Encode 

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

Encode implements json.Marshaler.

func (*ErrorResponseSchema) GetMessage 

func (s *ErrorResponseSchema) GetMessage() string

GetMessage returns the value of Message.

func (*ErrorResponseSchema) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ErrorResponseSchema) SetMessage 

func (s *ErrorResponseSchema) SetMessage(val string)

SetMessage sets the value of Message.

func (*ErrorResponseSchema) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type GetHealthParams 

type GetHealthParams struct {
	// Message.
	Message string
}

GetHealthParams is parameters of getHealth operation.

type GetHealthRes 

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

type Handler 

type Handler interface {
	// GetHealth implements getHealth operation.
	//
	// Health.
	//
	// GET /health
	GetHealth(ctx context.Context, params GetHealthParams) (GetHealthRes, error)
	// PostHealth implements postHealth operation.
	//
	// Health.
	//
	// POST /health
	PostHealth(ctx context.Context, req *HealthRequestSchema) (PostHealthRes, error)
}

Handler handles operations described by OpenAPI v3 specification.

type HealthRequestSchema 

type HealthRequestSchema struct {
	// Message.
	Message string `json:"message"`
}

Ref: #/components/schemas/HealthRequestSchema

func (*HealthRequestSchema) Decode 

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

Decode decodes HealthRequestSchema from json.

func (*HealthRequestSchema) Encode 

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

Encode implements json.Marshaler.

func (*HealthRequestSchema) GetMessage 

func (s *HealthRequestSchema) GetMessage() string

GetMessage returns the value of Message.

func (*HealthRequestSchema) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*HealthRequestSchema) SetMessage 

func (s *HealthRequestSchema) SetMessage(val string)

SetMessage sets the value of Message.

func (*HealthRequestSchema) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type HealthResponseSchema 

type HealthResponseSchema struct {
	// Message.
	Message string `json:"message"`
}

Ref: #/components/schemas/HealthResponseSchema

func (*HealthResponseSchema) Decode 

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

Decode decodes HealthResponseSchema from json.

func (*HealthResponseSchema) Encode 

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

Encode implements json.Marshaler.

func (*HealthResponseSchema) GetMessage 

func (s *HealthResponseSchema) GetMessage() string

GetMessage returns the value of Message.

func (*HealthResponseSchema) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*HealthResponseSchema) SetMessage 

func (s *HealthResponseSchema) SetMessage(val string)

SetMessage sets the value of Message.

func (*HealthResponseSchema) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Invoker 

type Invoker interface {
	// GetHealth invokes getHealth operation.
	//
	// Health.
	//
	// GET /health
	GetHealth(ctx context.Context, params GetHealthParams) (GetHealthRes, error)
	// PostHealth invokes postHealth operation.
	//
	// Health.
	//
	// POST /health
	PostHealth(ctx context.Context, request *HealthRequestSchema) (PostHealthRes, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

type Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

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 PostHealthRes 

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

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

func (UnimplementedHandler) GetHealth(ctx context.Context, params GetHealthParams) (r GetHealthRes, _ error)

GetHealth implements getHealth operation.

Health.

GET /health

func (UnimplementedHandler) PostHealth 

func (UnimplementedHandler) PostHealth(ctx context.Context, req *HealthRequestSchema) (r PostHealthRes, _ error)

PostHealth implements postHealth operation.

Health.

POST /health

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.