api

package
v0.0.0-...-2c50256 Latest Latest
Warning

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

 Go to latest Published: Mar 31, 2024 License: Apache-2.0 Imports: 27 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, sec SecuritySource, opts ...ClientOption) (*Client, error)

NewClient initializes new Client defined by OAS.

func (*Client) AddPet 

func (c *Client) AddPet(ctx context.Context, request *NewPet) (*Pet, error)

AddPet invokes addPet operation.

Creates a new pet in the store. Duplicates are allowed.

POST /pets

func (*Client) DeletePet 

func (c *Client) DeletePet(ctx context.Context, params DeletePetParams) error

DeletePet invokes deletePet operation.

Deletes a single pet based on the ID supplied.

DELETE /pets/{id}

func (*Client) FindPetByID 

func (c *Client) FindPetByID(ctx context.Context, params FindPetByIDParams) (*Pet, error)

FindPetByID invokes find pet by id operation.

Returns a user based on a single ID, if the user does not have access to the pet.

GET /pets/{id}

func (*Client) FindPets 

func (c *Client) FindPets(ctx context.Context, params FindPetsParams) ([]Pet, error)

FindPets invokes findPets operation.

Returns all pets from the system that the user has access to Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, 

vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.

GET /pets

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 DeletePetNoContent 

type DeletePetNoContent struct{}

DeletePetNoContent is response for DeletePet operation.

type DeletePetParams 

type DeletePetParams struct {
	// ID of pet to delete.
	ID int64
}

DeletePetParams is parameters of deletePet operation.

type Error 

type Error struct {
	Code    int32  `json:"code"`
	Message string `json:"message"`
}

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

func (s *Error) GetCode() int32

GetCode returns the value of Code.

func (*Error) GetMessage 

func (s *Error) GetMessage() string

GetMessage returns the value of Message.

func (*Error) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*Error) SetCode 

func (s *Error) SetCode(val int32)

SetCode sets the value of Code.

func (*Error) SetMessage 

func (s *Error) SetMessage(val string)

SetMessage sets the value of Message.

func (*Error) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ErrorHandler 

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

func (*ErrorStatusCode) GetResponse 

func (s *ErrorStatusCode) GetResponse() Error

GetResponse returns the value of Response.

func (*ErrorStatusCode) GetStatusCode 

func (s *ErrorStatusCode) GetStatusCode() int

GetStatusCode returns the value of StatusCode.

func (*ErrorStatusCode) SetResponse 

func (s *ErrorStatusCode) SetResponse(val Error)

SetResponse sets the value of Response.

func (*ErrorStatusCode) SetStatusCode 

func (s *ErrorStatusCode) SetStatusCode(val int)

SetStatusCode sets the value of StatusCode.

type FindPetByIDParams 

type FindPetByIDParams struct {
	// ID of pet to fetch.
	ID int64
}

FindPetByIDParams is parameters of find pet by id operation.

type FindPetsParams 

type FindPetsParams struct {
	// Tags to filter by.
	Tags []string
	// Maximum number of results to return.
	Limit OptInt32
}

FindPetsParams is parameters of findPets operation.

type Handler 

type Handler interface {
	// AddPet implements addPet operation.
	//
	// Creates a new pet in the store. Duplicates are allowed.
	//
	// POST /pets
	AddPet(ctx context.Context, req *NewPet) (*Pet, error)
	// DeletePet implements deletePet operation.
	//
	// Deletes a single pet based on the ID supplied.
	//
	// DELETE /pets/{id}
	DeletePet(ctx context.Context, params DeletePetParams) error
	// FindPetByID implements find pet by id operation.
	//
	// Returns a user based on a single ID, if the user does not have access to the pet.
	//
	// GET /pets/{id}
	FindPetByID(ctx context.Context, params FindPetByIDParams) (*Pet, error)
	// FindPets implements findPets operation.
	//
	// Returns all pets from the system that the user has access to
	// Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet.
	// Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus
	// id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea
	// dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie
	// imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim
	// pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim
	// enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel,
	//  vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
	// Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus
	// nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra,
	// condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi
	// rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque
	// tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit
	// amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce
	// sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium,
	// pulvinar elit eu, euismod sapien.
	//
	// GET /pets
	FindPets(ctx context.Context, params FindPetsParams) ([]Pet, 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 Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

type NewPet 

type NewPet struct {
	Name string    `json:"name"`
	Tag  OptString `json:"tag"`
}

Ref: #/components/schemas/NewPet

func (*NewPet) Decode 

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

Decode decodes NewPet from json.

func (*NewPet) Encode 

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

Encode implements json.Marshaler.

func (*NewPet) GetName 

func (s *NewPet) GetName() string

GetName returns the value of Name.

func (*NewPet) GetTag 

func (s *NewPet) GetTag() OptString

GetTag returns the value of Tag.

func (*NewPet) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*NewPet) SetName 

func (s *NewPet) SetName(val string)

SetName sets the value of Name.

func (*NewPet) SetTag 

func (s *NewPet) SetTag(val OptString)

SetTag sets the value of Tag.

func (*NewPet) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type OAuth2 

type OAuth2 struct {
	Token  string
	Scopes []string
}

func (*OAuth2) GetScopes 

func (s *OAuth2) GetScopes() []string

GetScopes returns the value of Scopes.

func (*OAuth2) GetToken 

func (s *OAuth2) GetToken() string

GetToken returns the value of Token.

func (*OAuth2) SetScopes 

func (s *OAuth2) SetScopes(val []string)

SetScopes sets the value of Scopes.

func (*OAuth2) SetToken 

func (s *OAuth2) SetToken(val string)

SetToken sets the value of Token.

type OptInt32 

type OptInt32 struct {
	Value int32
	Set   bool
}

OptInt32 is optional int32.

func NewOptInt32 

func NewOptInt32(v int32) OptInt32

NewOptInt32 returns new OptInt32 with value set to v.

func (OptInt32) Get 

func (o OptInt32) Get() (v int32, ok bool)

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

func (OptInt32) IsSet 

func (o OptInt32) IsSet() bool

IsSet returns true if OptInt32 was set.

func (OptInt32) Or 

func (o OptInt32) Or(d int32) int32

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

func (*OptInt32) Reset 

func (o *OptInt32) Reset()

Reset unsets value.

func (*OptInt32) SetTo 

func (o *OptInt32) SetTo(v int32)

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

type Pet struct {
	Name string    `json:"name"`
	Tag  OptString `json:"tag"`
	ID   int64     `json:"id"`
}

Merged schema. Ref: #/components/schemas/Pet

func (*Pet) Decode 

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

Decode decodes Pet from json.

func (*Pet) Encode 

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

Encode implements json.Marshaler.

func (*Pet) GetID 

func (s *Pet) GetID() int64

GetID returns the value of ID.

func (*Pet) GetName 

func (s *Pet) GetName() string

GetName returns the value of Name.

func (*Pet) GetTag 

func (s *Pet) GetTag() OptString

GetTag returns the value of Tag.

func (*Pet) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*Pet) SetID 

func (s *Pet) SetID(val int64)

SetID sets the value of ID.

func (*Pet) SetName 

func (s *Pet) SetName(val string)

SetName sets the value of Name.

func (*Pet) SetTag 

func (s *Pet) SetTag(val OptString)

SetTag sets the value of Tag.

func (*Pet) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

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.

type SecurityHandler 

type SecurityHandler interface {
	// HandleOAuth2 handles oauth2 security.
	HandleOAuth2(ctx context.Context, operationName string, t OAuth2) (context.Context, error)
}

SecurityHandler is handler for security parameters.

type SecuritySource 

type SecuritySource interface {
	// OAuth2 provides oauth2 security value.
	OAuth2(ctx context.Context, operationName string) (OAuth2, error)
}

SecuritySource is provider of security values (tokens, passwords, etc.).

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, sec SecurityHandler, 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) AddPet 

func (UnimplementedHandler) AddPet(ctx context.Context, req *NewPet) (r *Pet, _ error)

AddPet implements addPet operation.

Creates a new pet in the store. Duplicates are allowed.

POST /pets

func (UnimplementedHandler) DeletePet 

func (UnimplementedHandler) DeletePet(ctx context.Context, params DeletePetParams) error

DeletePet implements deletePet operation.

Deletes a single pet based on the ID supplied.

DELETE /pets/{id}

func (UnimplementedHandler) FindPetByID 

func (UnimplementedHandler) FindPetByID(ctx context.Context, params FindPetByIDParams) (r *Pet, _ error)

FindPetByID implements find pet by id operation.

Returns a user based on a single ID, if the user does not have access to the pet.

GET /pets/{id}

func (UnimplementedHandler) FindPets 

func (UnimplementedHandler) FindPets(ctx context.Context, params FindPetsParams) (r []Pet, _ error)

FindPets implements findPets operation.

Returns all pets from the system that the user has access to Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, 

vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.

GET /pets

func (UnimplementedHandler) NewError 

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.