Documentation

Overview

    Package illegal_enum_names provides primitives to interact the openapi HTTP API.

    Code generated by github.com/ebauman/oapi-codegen DO NOT EDIT.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func GetSwagger

    func GetSwagger() (*openapi3.Swagger, error)

      GetSwagger returns the Swagger specification corresponding to the generated code in this file.

      func NewGetFooRequest

      func NewGetFooRequest(server string) (*http.Request, error)

        NewGetFooRequest generates requests for GetFoo

        func RegisterHandlers

        func RegisterHandlers(router EchoRouter, si ServerInterface)

          RegisterHandlers adds each server route to the EchoRouter.

          Types

          type Bar

          type Bar string

            Bar defines model for Bar.

            const (
            	Bar_Bar      Bar = "Bar"
            	Bar_Foo      Bar = "Foo"
            	Bar_Foo_Bar  Bar = "Foo Bar"
            	Bar_Foo_Bar1 Bar = "Foo-Bar"
            	Bar__Foo     Bar = "1Foo"
            	Bar__Foo1    Bar = " Foo"
            	Bar__Foo_    Bar = " Foo "
            	Bar__Foo_1   Bar = "_Foo_"
            )

              List of Bar

              type Client

              type Client struct {
              	// The endpoint of the server conforming to this interface, with scheme,
              	// https://api.deepmap.com for example.
              	Server string
              
              	// Doer for performing requests, typically a *http.Client with any
              	// customized settings, such as certificate chains.
              	Client HttpRequestDoer
              
              	// A callback for modifying requests which are generated before sending over
              	// the network.
              	RequestEditor RequestEditorFn
              }

                Client which conforms to the OpenAPI3 specification for this service.

                func NewClient

                func NewClient(server string, opts ...ClientOption) (*Client, error)

                  Creates a new Client, with reasonable defaults

                  func (*Client) GetFoo

                  func (c *Client) GetFoo(ctx context.Context) (*http.Response, error)

                  type ClientInterface

                  type ClientInterface interface {
                  	// GetFoo request
                  	GetFoo(ctx context.Context) (*http.Response, error)
                  }

                    The interface specification for the client above.

                    type ClientOption

                    type ClientOption func(*Client) error

                      ClientOption allows setting custom parameters during construction

                      func WithBaseURL

                      func WithBaseURL(baseURL string) ClientOption

                        WithBaseURL overrides the baseURL.

                        func WithHTTPClient

                        func WithHTTPClient(doer HttpRequestDoer) ClientOption

                          WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

                          func WithRequestEditorFn

                          func WithRequestEditorFn(fn RequestEditorFn) ClientOption

                            WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

                            type ClientWithResponses

                            type ClientWithResponses struct {
                            	ClientInterface
                            }

                              ClientWithResponses builds on ClientInterface to offer response payloads

                              func NewClientWithResponses

                              func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

                                NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

                                func (*ClientWithResponses) GetFooWithResponse

                                func (c *ClientWithResponses) GetFooWithResponse(ctx context.Context) (*GetFooResponse, error)

                                  GetFooWithResponse request returning *GetFooResponse

                                  type ClientWithResponsesInterface

                                  type ClientWithResponsesInterface interface {
                                  	// GetFoo request
                                  	GetFooWithResponse(ctx context.Context) (*GetFooResponse, error)
                                  }

                                    ClientWithResponsesInterface is the interface specification for the client with responses above.

                                    type EchoRouter

                                    type EchoRouter interface {
                                    	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
                                    	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
                                    	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
                                    	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
                                    	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
                                    	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
                                    	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
                                    	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
                                    	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
                                    }

                                      This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration

                                      type GetFooResponse

                                      type GetFooResponse struct {
                                      	Body         []byte
                                      	HTTPResponse *http.Response
                                      	JSON200      *[]Bar
                                      }

                                      func ParseGetFooResponse

                                      func ParseGetFooResponse(rsp *http.Response) (*GetFooResponse, error)

                                        ParseGetFooResponse parses an HTTP response from a GetFooWithResponse call

                                        func (GetFooResponse) Status

                                        func (r GetFooResponse) Status() string

                                          Status returns HTTPResponse.Status

                                          func (GetFooResponse) StatusCode

                                          func (r GetFooResponse) StatusCode() int

                                            StatusCode returns HTTPResponse.StatusCode

                                            type HttpRequestDoer

                                            type HttpRequestDoer interface {
                                            	Do(req *http.Request) (*http.Response, error)
                                            }

                                              Doer performs HTTP requests.

                                              The standard http.Client implements this interface.

                                              type RequestEditorFn

                                              type RequestEditorFn func(ctx context.Context, req *http.Request) error

                                                RequestEditorFn is the function signature for the RequestEditor callback function

                                                type ServerInterface

                                                type ServerInterface interface {
                                                
                                                	// (GET /foo)
                                                	GetFoo(ctx echo.Context) error
                                                }

                                                  ServerInterface represents all server handlers.

                                                  type ServerInterfaceWrapper

                                                  type ServerInterfaceWrapper struct {
                                                  	Handler ServerInterface
                                                  }

                                                    ServerInterfaceWrapper converts echo contexts to parameters.

                                                    func (*ServerInterfaceWrapper) GetFoo

                                                    func (w *ServerInterfaceWrapper) GetFoo(ctx echo.Context) error

                                                      GetFoo converts echo context to params.