api

package
v0.46.1 Latest Latest
Warning

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

 Go to latest Published: Aug 8, 2022 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Overview

Code generated by ogen, DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client implements OAS client.

func NewClient 

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

NewClient initializes new Client defined by OAS.

func (*Client) DataCreate 

func (c *Client) DataCreate(ctx context.Context, request OptData) (res Data, err error)

DataCreate invokes dataCreate operation.

Creates data.

POST /data

func (*Client) DataGet 

func (c *Client) DataGet(ctx context.Context) (res Data, err error)

DataGet invokes dataGet operation.

Retrieve data.

GET /data

type Data 

type Data struct {
	Name string "json:\"name\""
}

Some data. Ref: #/components/schemas/Data

func (*Data) Decode 

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

Decode decodes Data from json.

func (Data) Encode 

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

Encode implements json.Marshaler.

func (Data) MarshalJSON added in v0.20.0 

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

MarshalJSON implements stdjson.Marshaler.

func (*Data) UnmarshalJSON added in v0.20.0 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Error 

type Error struct {
	Code    int64  "json:\"code\""
	Message string "json:\"message\""
}

Represents error object. Ref: #/components/schemas/Error

func (*Error) Decode 

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

Decode decodes Error from json.

func (Error) Encode 

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

Encode implements json.Marshaler.

func (Error) MarshalJSON added in v0.20.0 

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

MarshalJSON implements stdjson.Marshaler.

func (*Error) UnmarshalJSON added in v0.20.0 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ErrorHandler added in v0.25.0 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type ErrorStatusCode 

type ErrorStatusCode struct {
	StatusCode int
	Response   Error
}

ErrorStatusCode wraps Error with StatusCode.

func (*ErrorStatusCode) Error 

func (s *ErrorStatusCode) Error() string

type Handler 

type Handler interface {
	// DataCreate implements dataCreate operation.
	//
	// Creates data.
	//
	// POST /data
	DataCreate(ctx context.Context, req OptData) (Data, error)
	// DataGet implements dataGet operation.
	//
	// Retrieve data.
	//
	// GET /data
	DataGet(ctx context.Context) (Data, error)
	// NewError creates ErrorStatusCode from error returned by handler.
	//
	// Used for common default response.
	NewError(ctx context.Context, err error) ErrorStatusCode
}

Handler handles operations described by OpenAPI v3 specification.

type OptData 

type OptData struct {
	Value Data
	Set   bool
}

OptData is optional Data.

func NewOptData 

func NewOptData(v Data) OptData

NewOptData returns new OptData with value set to v.

func (*OptData) Decode 

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

Decode decodes Data from json.

func (OptData) Encode 

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

Encode encodes Data as json.

func (OptData) Get 

func (o OptData) Get() (v Data, ok bool)

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

func (OptData) IsSet 

func (o OptData) IsSet() bool

IsSet returns true if OptData was set.

func (OptData) MarshalJSON added in v0.20.0 

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

MarshalJSON implements stdjson.Marshaler.

func (OptData) Or added in v0.4.0 

func (o OptData) Or(d Data) Data

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

func (*OptData) Reset 

func (o *OptData) Reset()

Reset unsets value.

func (*OptData) SetTo 

func (o *OptData) SetTo(v Data)

SetTo sets value to v.

func (*OptData) UnmarshalJSON added in v0.20.0 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Option 

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

func WithClient 

func WithClient(client ht.Client) Option

WithClient specifies http client to use.

func WithErrorHandler added in v0.25.0 

func WithErrorHandler(h ErrorHandler) Option

WithErrorHandler specifies error handler to use.

func WithMaxMultipartMemory added in v0.34.0 

func WithMaxMultipartMemory(max int64) Option

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 WithMeterProvider added in v0.13.0 

func WithMeterProvider(provider metric.MeterProvider) Option

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

If none is specified, the metric.NewNoopMeterProvider is used.

func WithMethodNotAllowed added in v0.46.0 

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

WithMethodNotAllowed specifies Method Not Allowed handler to use.

func WithNotFound added in v0.18.0 

func WithNotFound(notFound http.HandlerFunc) Option

WithNotFound specifies Not Found handler to use.

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 added in v0.8.0 

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

Route is route object.

func (Route) Args added in v0.8.0 

func (r Route) Args() []string

Args returns parsed arguments.

func (Route) Name added in v0.46.0 

func (r Route) Name() string

Name returns ogen operation name.

It is guaranteed to be unique and not empty.

func (Route) OperationID added in v0.8.0 

func (r Route) OperationID() string

OperationID returns OpenAPI operationId.

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 ...Option) (*Server, error)

func (*Server) FindRoute added in v0.8.0 

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

FindRoute finds Route for given method and path.

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 UnimplementedHandler added in v0.18.0 

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) DataCreate added in v0.18.0 

func (UnimplementedHandler) DataCreate(ctx context.Context, req OptData) (r Data, _ error)

DataCreate implements dataCreate operation.

Creates data.

POST /data

func (UnimplementedHandler) DataGet added in v0.18.0 

func (UnimplementedHandler) DataGet(ctx context.Context) (r Data, _ error)

DataGet implements dataGet operation.

Retrieve data.

GET /data

func (UnimplementedHandler) NewError added in v0.18.0 

func (UnimplementedHandler) NewError(ctx context.Context, err error) (r ErrorStatusCode)

NewError creates ErrorStatusCode from error returned by handler.

Used for common default response.

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.