api

package
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Dec 16, 2022 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/do87/oapi-codegen version (devel) DO NOT EDIT.

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/do87/oapi-codegen version (devel) DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSwagger 

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func PathToRawSpec 

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

func RegisterHandlers 

func RegisterHandlers(router *gin.Engine, si ServerInterface) *gin.Engine

RegisterHandlers creates http.Handler with routing matching OpenAPI spec.

func RegisterHandlersWithOptions 

func RegisterHandlersWithOptions(router *gin.Engine, si ServerInterface, options GinServerOptions) *gin.Engine

RegisterHandlersWithOptions creates http.Handler with additional options

Types

type BadrequestResponse 

type BadrequestResponse struct {
}

type Example 

type Example struct {
	Value *string `json:"value,omitempty"`
}

Example defines model for example.

type GinServerOptions 

type GinServerOptions struct {
	BaseURL      string
	Middlewares  []MiddlewareFunc
	ErrorHandler func(*gin.Context, error, int)
}

GinServerOptions provides options for the Gin server.

type HeadersExample200JSONResponse 

type HeadersExample200JSONResponse struct {
	Body    Example
	Headers HeadersExample200ResponseHeaders
}

func (HeadersExample200JSONResponse) VisitHeadersExampleResponse 

func (response HeadersExample200JSONResponse) VisitHeadersExampleResponse(w http.ResponseWriter) error

type HeadersExample200ResponseHeaders 

type HeadersExample200ResponseHeaders struct {
	Header1 string
	Header2 int
}

type HeadersExample400Response 

type HeadersExample400Response = BadrequestResponse

func (HeadersExample400Response) VisitHeadersExampleResponse 

func (response HeadersExample400Response) VisitHeadersExampleResponse(w http.ResponseWriter) error

type HeadersExampleJSONRequestBody 

type HeadersExampleJSONRequestBody = Example

HeadersExampleJSONRequestBody defines body for HeadersExample for application/json ContentType.

type HeadersExampleParams 

type HeadersExampleParams struct {
	Header1 string `json:"header1"`
	Header2 *int   `json:"header2,omitempty"`
}

HeadersExampleParams defines parameters for HeadersExample.

type HeadersExampleRequestObject 

type HeadersExampleRequestObject struct {
	Params HeadersExampleParams
	Body   *HeadersExampleJSONRequestBody
}

type HeadersExampleResponseObject 

type HeadersExampleResponseObject interface {
	VisitHeadersExampleResponse(w http.ResponseWriter) error
}

type HeadersExampledefaultResponse 

type HeadersExampledefaultResponse struct {
	StatusCode int
}

func (HeadersExampledefaultResponse) VisitHeadersExampleResponse 

func (response HeadersExampledefaultResponse) VisitHeadersExampleResponse(w http.ResponseWriter) error

type JSONExample200JSONResponse 

type JSONExample200JSONResponse Example

func (JSONExample200JSONResponse) VisitJSONExampleResponse 

func (response JSONExample200JSONResponse) VisitJSONExampleResponse(w http.ResponseWriter) error

type JSONExample400Response 

type JSONExample400Response = BadrequestResponse

func (JSONExample400Response) VisitJSONExampleResponse 

func (response JSONExample400Response) VisitJSONExampleResponse(w http.ResponseWriter) error

type JSONExampleJSONRequestBody 

type JSONExampleJSONRequestBody = Example

JSONExampleJSONRequestBody defines body for JSONExample for application/json ContentType.

type JSONExampleRequestObject 

type JSONExampleRequestObject struct {
	Body *JSONExampleJSONRequestBody
}

type JSONExampleResponseObject 

type JSONExampleResponseObject interface {
	VisitJSONExampleResponse(w http.ResponseWriter) error
}

type JSONExampledefaultResponse 

type JSONExampledefaultResponse struct {
	StatusCode int
}

func (JSONExampledefaultResponse) VisitJSONExampleResponse 

func (response JSONExampledefaultResponse) VisitJSONExampleResponse(w http.ResponseWriter) error

type MiddlewareFunc 

type MiddlewareFunc func(c *gin.Context)

type MultipartExample200MultipartResponse 

type MultipartExample200MultipartResponse func(writer *multipart.Writer) error

func (MultipartExample200MultipartResponse) VisitMultipartExampleResponse 

func (response MultipartExample200MultipartResponse) VisitMultipartExampleResponse(w http.ResponseWriter) error

type MultipartExample400Response 

type MultipartExample400Response = BadrequestResponse

func (MultipartExample400Response) VisitMultipartExampleResponse 

func (response MultipartExample400Response) VisitMultipartExampleResponse(w http.ResponseWriter) error

type MultipartExampleMultipartRequestBody 

type MultipartExampleMultipartRequestBody = Example

MultipartExampleMultipartRequestBody defines body for MultipartExample for multipart/form-data ContentType.

type MultipartExampleRequestObject 

type MultipartExampleRequestObject struct {
	Body *multipart.Reader
}

type MultipartExampleResponseObject 

type MultipartExampleResponseObject interface {
	VisitMultipartExampleResponse(w http.ResponseWriter) error
}

type MultipartExampledefaultResponse 

type MultipartExampledefaultResponse struct {
	StatusCode int
}

func (MultipartExampledefaultResponse) VisitMultipartExampleResponse 

func (response MultipartExampledefaultResponse) VisitMultipartExampleResponse(w http.ResponseWriter) error

type MultipleRequestAndResponseTypes200FormdataResponse 

type MultipleRequestAndResponseTypes200FormdataResponse Example

func (MultipleRequestAndResponseTypes200FormdataResponse) VisitMultipleRequestAndResponseTypesResponse 

func (response MultipleRequestAndResponseTypes200FormdataResponse) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

type MultipleRequestAndResponseTypes200ImagepngResponse 

type MultipleRequestAndResponseTypes200ImagepngResponse struct {
	Body          io.Reader
	ContentLength int64
}

func (MultipleRequestAndResponseTypes200ImagepngResponse) VisitMultipleRequestAndResponseTypesResponse 

func (response MultipleRequestAndResponseTypes200ImagepngResponse) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

type MultipleRequestAndResponseTypes200JSONResponse 

type MultipleRequestAndResponseTypes200JSONResponse Example

func (MultipleRequestAndResponseTypes200JSONResponse) VisitMultipleRequestAndResponseTypesResponse 

func (response MultipleRequestAndResponseTypes200JSONResponse) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

type MultipleRequestAndResponseTypes200MultipartResponse 

type MultipleRequestAndResponseTypes200MultipartResponse func(writer *multipart.Writer) error

func (MultipleRequestAndResponseTypes200MultipartResponse) VisitMultipleRequestAndResponseTypesResponse 

func (response MultipleRequestAndResponseTypes200MultipartResponse) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

type MultipleRequestAndResponseTypes200TextResponse 

type MultipleRequestAndResponseTypes200TextResponse string

func (MultipleRequestAndResponseTypes200TextResponse) VisitMultipleRequestAndResponseTypesResponse 

func (response MultipleRequestAndResponseTypes200TextResponse) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

type MultipleRequestAndResponseTypes400Response 

type MultipleRequestAndResponseTypes400Response = BadrequestResponse

func (MultipleRequestAndResponseTypes400Response) VisitMultipleRequestAndResponseTypesResponse 

func (response MultipleRequestAndResponseTypes400Response) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

type MultipleRequestAndResponseTypesFormdataRequestBody 

type MultipleRequestAndResponseTypesFormdataRequestBody = Example

MultipleRequestAndResponseTypesFormdataRequestBody defines body for MultipleRequestAndResponseTypes for application/x-www-form-urlencoded ContentType.

type MultipleRequestAndResponseTypesJSONRequestBody 

type MultipleRequestAndResponseTypesJSONRequestBody = Example

MultipleRequestAndResponseTypesJSONRequestBody defines body for MultipleRequestAndResponseTypes for application/json ContentType.

type MultipleRequestAndResponseTypesMultipartRequestBody 

type MultipleRequestAndResponseTypesMultipartRequestBody = Example

MultipleRequestAndResponseTypesMultipartRequestBody defines body for MultipleRequestAndResponseTypes for multipart/form-data ContentType.

type MultipleRequestAndResponseTypesRequestObject 

type MultipleRequestAndResponseTypesRequestObject struct {
	JSONBody      *MultipleRequestAndResponseTypesJSONRequestBody
	FormdataBody  *MultipleRequestAndResponseTypesFormdataRequestBody
	Body          io.Reader
	MultipartBody *multipart.Reader
	TextBody      *MultipleRequestAndResponseTypesTextRequestBody
}

type MultipleRequestAndResponseTypesResponseObject 

type MultipleRequestAndResponseTypesResponseObject interface {
	VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error
}

type MultipleRequestAndResponseTypesTextBody 

type MultipleRequestAndResponseTypesTextBody = string

MultipleRequestAndResponseTypesTextBody defines parameters for MultipleRequestAndResponseTypes.

type MultipleRequestAndResponseTypesTextRequestBody 

type MultipleRequestAndResponseTypesTextRequestBody = MultipleRequestAndResponseTypesTextBody

MultipleRequestAndResponseTypesTextRequestBody defines body for MultipleRequestAndResponseTypes for text/plain ContentType.

type ReusableResponses200JSONResponse 

type ReusableResponses200JSONResponse struct{ ReusableresponseJSONResponse }

func (ReusableResponses200JSONResponse) VisitReusableResponsesResponse 

func (response ReusableResponses200JSONResponse) VisitReusableResponsesResponse(w http.ResponseWriter) error

type ReusableResponses400Response 

type ReusableResponses400Response = BadrequestResponse

func (ReusableResponses400Response) VisitReusableResponsesResponse 

func (response ReusableResponses400Response) VisitReusableResponsesResponse(w http.ResponseWriter) error

type ReusableResponsesJSONRequestBody 

type ReusableResponsesJSONRequestBody = Example

ReusableResponsesJSONRequestBody defines body for ReusableResponses for application/json ContentType.

type ReusableResponsesRequestObject 

type ReusableResponsesRequestObject struct {
	Body *ReusableResponsesJSONRequestBody
}

type ReusableResponsesResponseObject 

type ReusableResponsesResponseObject interface {
	VisitReusableResponsesResponse(w http.ResponseWriter) error
}

type ReusableResponsesdefaultResponse 

type ReusableResponsesdefaultResponse struct {
	StatusCode int
}

func (ReusableResponsesdefaultResponse) VisitReusableResponsesResponse 

func (response ReusableResponsesdefaultResponse) VisitReusableResponsesResponse(w http.ResponseWriter) error

type Reusableresponse 

type Reusableresponse = Example

Reusableresponse defines model for reusableresponse.

type ReusableresponseJSONResponse 

type ReusableresponseJSONResponse struct {
	Body Example

	Headers ReusableresponseResponseHeaders
}

type ReusableresponseResponseHeaders 

type ReusableresponseResponseHeaders struct {
	Header1 string
	Header2 int
}

type ServerInterface 

type ServerInterface interface {

	// (POST /json)
	JSONExample(c *gin.Context)

	// (POST /multipart)
	MultipartExample(c *gin.Context)

	// (POST /multiple)
	MultipleRequestAndResponseTypes(c *gin.Context)

	// (POST /reusable-responses)
	ReusableResponses(c *gin.Context)

	// (POST /text)
	TextExample(c *gin.Context)

	// (POST /unknown)
	UnknownExample(c *gin.Context)

	// (POST /unspecified-content-type)
	UnspecifiedContentType(c *gin.Context)

	// (POST /urlencoded)
	URLEncodedExample(c *gin.Context)

	// (POST /with-headers)
	HeadersExample(c *gin.Context, params HeadersExampleParams)
}

ServerInterface represents all server handlers.

func NewStrictHandler 

func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandler       func(*gin.Context, error, int)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) HeadersExample 

func (siw *ServerInterfaceWrapper) HeadersExample(c *gin.Context)

HeadersExample operation middleware

func (*ServerInterfaceWrapper) JSONExample 

func (siw *ServerInterfaceWrapper) JSONExample(c *gin.Context)

JSONExample operation middleware

func (*ServerInterfaceWrapper) MultipartExample 

func (siw *ServerInterfaceWrapper) MultipartExample(c *gin.Context)

MultipartExample operation middleware

func (*ServerInterfaceWrapper) MultipleRequestAndResponseTypes 

func (siw *ServerInterfaceWrapper) MultipleRequestAndResponseTypes(c *gin.Context)

MultipleRequestAndResponseTypes operation middleware

func (*ServerInterfaceWrapper) ReusableResponses 

func (siw *ServerInterfaceWrapper) ReusableResponses(c *gin.Context)

ReusableResponses operation middleware

func (*ServerInterfaceWrapper) TextExample 

func (siw *ServerInterfaceWrapper) TextExample(c *gin.Context)

TextExample operation middleware

func (*ServerInterfaceWrapper) URLEncodedExample 

func (siw *ServerInterfaceWrapper) URLEncodedExample(c *gin.Context)

URLEncodedExample operation middleware

func (*ServerInterfaceWrapper) UnknownExample 

func (siw *ServerInterfaceWrapper) UnknownExample(c *gin.Context)

UnknownExample operation middleware

func (*ServerInterfaceWrapper) UnspecifiedContentType 

func (siw *ServerInterfaceWrapper) UnspecifiedContentType(c *gin.Context)

UnspecifiedContentType operation middleware

type StrictHandlerFunc 

type StrictHandlerFunc func(ctx *gin.Context, args interface{}) (interface{}, error)

type StrictMiddlewareFunc 

type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc

type StrictServer 

type StrictServer struct {
}

func (StrictServer) HeadersExample 

func (s StrictServer) HeadersExample(ctx context.Context, request HeadersExampleRequestObject) (HeadersExampleResponseObject, error)

func (StrictServer) JSONExample 

func (s StrictServer) JSONExample(ctx context.Context, request JSONExampleRequestObject) (JSONExampleResponseObject, error)

func (StrictServer) MultipartExample 

func (s StrictServer) MultipartExample(ctx context.Context, request MultipartExampleRequestObject) (MultipartExampleResponseObject, error)

func (StrictServer) MultipleRequestAndResponseTypes 

func (s StrictServer) MultipleRequestAndResponseTypes(ctx context.Context, request MultipleRequestAndResponseTypesRequestObject) (MultipleRequestAndResponseTypesResponseObject, error)

func (StrictServer) ReusableResponses 

func (s StrictServer) ReusableResponses(ctx context.Context, request ReusableResponsesRequestObject) (ReusableResponsesResponseObject, error)

func (StrictServer) TextExample 

func (s StrictServer) TextExample(ctx context.Context, request TextExampleRequestObject) (TextExampleResponseObject, error)

func (StrictServer) URLEncodedExample 

func (s StrictServer) URLEncodedExample(ctx context.Context, request URLEncodedExampleRequestObject) (URLEncodedExampleResponseObject, error)

func (StrictServer) UnknownExample 

func (s StrictServer) UnknownExample(ctx context.Context, request UnknownExampleRequestObject) (UnknownExampleResponseObject, error)

func (StrictServer) UnspecifiedContentType 

func (s StrictServer) UnspecifiedContentType(ctx context.Context, request UnspecifiedContentTypeRequestObject) (UnspecifiedContentTypeResponseObject, error)

type StrictServerInterface 

type StrictServerInterface interface {

	// (POST /json)
	JSONExample(ctx context.Context, request JSONExampleRequestObject) (JSONExampleResponseObject, error)

	// (POST /multipart)
	MultipartExample(ctx context.Context, request MultipartExampleRequestObject) (MultipartExampleResponseObject, error)

	// (POST /multiple)
	MultipleRequestAndResponseTypes(ctx context.Context, request MultipleRequestAndResponseTypesRequestObject) (MultipleRequestAndResponseTypesResponseObject, error)

	// (POST /reusable-responses)
	ReusableResponses(ctx context.Context, request ReusableResponsesRequestObject) (ReusableResponsesResponseObject, error)

	// (POST /text)
	TextExample(ctx context.Context, request TextExampleRequestObject) (TextExampleResponseObject, error)

	// (POST /unknown)
	UnknownExample(ctx context.Context, request UnknownExampleRequestObject) (UnknownExampleResponseObject, error)

	// (POST /unspecified-content-type)
	UnspecifiedContentType(ctx context.Context, request UnspecifiedContentTypeRequestObject) (UnspecifiedContentTypeResponseObject, error)

	// (POST /urlencoded)
	URLEncodedExample(ctx context.Context, request URLEncodedExampleRequestObject) (URLEncodedExampleResponseObject, error)

	// (POST /with-headers)
	HeadersExample(ctx context.Context, request HeadersExampleRequestObject) (HeadersExampleResponseObject, error)
}

StrictServerInterface represents all server handlers.

type TextExample200TextResponse 

type TextExample200TextResponse string

func (TextExample200TextResponse) VisitTextExampleResponse 

func (response TextExample200TextResponse) VisitTextExampleResponse(w http.ResponseWriter) error

type TextExample400Response 

type TextExample400Response = BadrequestResponse

func (TextExample400Response) VisitTextExampleResponse 

func (response TextExample400Response) VisitTextExampleResponse(w http.ResponseWriter) error

type TextExampleRequestObject 

type TextExampleRequestObject struct {
	Body *TextExampleTextRequestBody
}

type TextExampleResponseObject 

type TextExampleResponseObject interface {
	VisitTextExampleResponse(w http.ResponseWriter) error
}

type TextExampleTextBody 

type TextExampleTextBody = string

TextExampleTextBody defines parameters for TextExample.

type TextExampleTextRequestBody 

type TextExampleTextRequestBody = TextExampleTextBody

TextExampleTextRequestBody defines body for TextExample for text/plain ContentType.

type TextExampledefaultResponse 

type TextExampledefaultResponse struct {
	StatusCode int
}

func (TextExampledefaultResponse) VisitTextExampleResponse 

func (response TextExampledefaultResponse) VisitTextExampleResponse(w http.ResponseWriter) error

type URLEncodedExample200FormdataResponse 

type URLEncodedExample200FormdataResponse Example

func (URLEncodedExample200FormdataResponse) VisitURLEncodedExampleResponse 

func (response URLEncodedExample200FormdataResponse) VisitURLEncodedExampleResponse(w http.ResponseWriter) error

type URLEncodedExample400Response 

type URLEncodedExample400Response = BadrequestResponse

func (URLEncodedExample400Response) VisitURLEncodedExampleResponse 

func (response URLEncodedExample400Response) VisitURLEncodedExampleResponse(w http.ResponseWriter) error

type URLEncodedExampleFormdataRequestBody 

type URLEncodedExampleFormdataRequestBody = Example

URLEncodedExampleFormdataRequestBody defines body for URLEncodedExample for application/x-www-form-urlencoded ContentType.

type URLEncodedExampleRequestObject 

type URLEncodedExampleRequestObject struct {
	Body *URLEncodedExampleFormdataRequestBody
}

type URLEncodedExampleResponseObject 

type URLEncodedExampleResponseObject interface {
	VisitURLEncodedExampleResponse(w http.ResponseWriter) error
}

type URLEncodedExampledefaultResponse 

type URLEncodedExampledefaultResponse struct {
	StatusCode int
}

func (URLEncodedExampledefaultResponse) VisitURLEncodedExampleResponse 

func (response URLEncodedExampledefaultResponse) VisitURLEncodedExampleResponse(w http.ResponseWriter) error

type UnknownExample200Videomp4Response 

type UnknownExample200Videomp4Response struct {
	Body          io.Reader
	ContentLength int64
}

func (UnknownExample200Videomp4Response) VisitUnknownExampleResponse 

func (response UnknownExample200Videomp4Response) VisitUnknownExampleResponse(w http.ResponseWriter) error

type UnknownExample400Response 

type UnknownExample400Response = BadrequestResponse

func (UnknownExample400Response) VisitUnknownExampleResponse 

func (response UnknownExample400Response) VisitUnknownExampleResponse(w http.ResponseWriter) error

type UnknownExampleRequestObject 

type UnknownExampleRequestObject struct {
	Body io.Reader
}

type UnknownExampleResponseObject 

type UnknownExampleResponseObject interface {
	VisitUnknownExampleResponse(w http.ResponseWriter) error
}

type UnknownExampledefaultResponse 

type UnknownExampledefaultResponse struct {
	StatusCode int
}

func (UnknownExampledefaultResponse) VisitUnknownExampleResponse 

func (response UnknownExampledefaultResponse) VisitUnknownExampleResponse(w http.ResponseWriter) error

type UnspecifiedContentType200VideoResponse 

type UnspecifiedContentType200VideoResponse struct {
	Body          io.Reader
	ContentType   string
	ContentLength int64
}

func (UnspecifiedContentType200VideoResponse) VisitUnspecifiedContentTypeResponse 

func (response UnspecifiedContentType200VideoResponse) VisitUnspecifiedContentTypeResponse(w http.ResponseWriter) error

type UnspecifiedContentType400Response 

type UnspecifiedContentType400Response = BadrequestResponse

func (UnspecifiedContentType400Response) VisitUnspecifiedContentTypeResponse 

func (response UnspecifiedContentType400Response) VisitUnspecifiedContentTypeResponse(w http.ResponseWriter) error

type UnspecifiedContentType401Response 

type UnspecifiedContentType401Response struct {
}

func (UnspecifiedContentType401Response) VisitUnspecifiedContentTypeResponse 

func (response UnspecifiedContentType401Response) VisitUnspecifiedContentTypeResponse(w http.ResponseWriter) error

type UnspecifiedContentType403Response 

type UnspecifiedContentType403Response struct {
}

func (UnspecifiedContentType403Response) VisitUnspecifiedContentTypeResponse 

func (response UnspecifiedContentType403Response) VisitUnspecifiedContentTypeResponse(w http.ResponseWriter) error

type UnspecifiedContentTypeRequestObject 

type UnspecifiedContentTypeRequestObject struct {
	ContentType string
	Body        io.Reader
}

type UnspecifiedContentTypeResponseObject 

type UnspecifiedContentTypeResponseObject interface {
	VisitUnspecifiedContentTypeResponse(w http.ResponseWriter) error
}

type UnspecifiedContentTypedefaultResponse 

type UnspecifiedContentTypedefaultResponse struct {
	StatusCode int
}

func (UnspecifiedContentTypedefaultResponse) VisitUnspecifiedContentTypeResponse 

func (response UnspecifiedContentTypedefaultResponse) VisitUnspecifiedContentTypeResponse(w http.ResponseWriter) error

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.