Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.0.2

Jan 18, 2024

v1.0.1

Jan 18, 2024

v1.0.0

Jan 18, 2024

Changes in this version

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

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

+ func RegisterHandlers(router fiber.Router, si ServerInterface)

+ func RegisterHandlersWithOptions(router fiber.Router, si ServerInterface, options FiberServerOptions)

+ type BadrequestResponse struct

+ type Example struct

+ Value *string

+ type FiberServerOptions struct

+ BaseURL string

+ Middlewares []MiddlewareFunc

+ type HeadersExample200JSONResponse struct

+ Body Example

+ Headers HeadersExample200ResponseHeaders

+ func (response HeadersExample200JSONResponse) VisitHeadersExampleResponse(ctx *fiber.Ctx) error

+ type HeadersExample200ResponseHeaders struct

+ Header1 string

+ Header2 int

+ type HeadersExample400Response = BadrequestResponse

+ func (response HeadersExample400Response) VisitHeadersExampleResponse(ctx *fiber.Ctx) error

+ type HeadersExampleJSONRequestBody = Example

+ type HeadersExampleParams struct

+ Header1 string

+ Header2 *int

+ type HeadersExampleRequestObject struct

+ Body *HeadersExampleJSONRequestBody

+ Params HeadersExampleParams

+ type HeadersExampleResponseObject interface

+ VisitHeadersExampleResponse func(ctx *fiber.Ctx) error

+ type HeadersExampledefaultResponse struct

+ StatusCode int

+ func (response HeadersExampledefaultResponse) VisitHeadersExampleResponse(ctx *fiber.Ctx) error

+ type JSONExample200JSONResponse Example

+ func (response JSONExample200JSONResponse) VisitJSONExampleResponse(ctx *fiber.Ctx) error

+ type JSONExample400Response = BadrequestResponse

+ func (response JSONExample400Response) VisitJSONExampleResponse(ctx *fiber.Ctx) error

+ type JSONExampleJSONRequestBody = Example

+ type JSONExampleRequestObject struct

+ Body *JSONExampleJSONRequestBody

+ type JSONExampleResponseObject interface

+ VisitJSONExampleResponse func(ctx *fiber.Ctx) error

+ type JSONExampledefaultResponse struct

+ StatusCode int

+ func (response JSONExampledefaultResponse) VisitJSONExampleResponse(ctx *fiber.Ctx) error

+ type MiddlewareFunc fiber.Handler

+ type MultipartExample200MultipartResponse func(writer *multipart.Writer) error

+ func (response MultipartExample200MultipartResponse) VisitMultipartExampleResponse(ctx *fiber.Ctx) error

+ type MultipartExample400Response = BadrequestResponse

+ func (response MultipartExample400Response) VisitMultipartExampleResponse(ctx *fiber.Ctx) error

+ type MultipartExampleMultipartRequestBody = Example

+ type MultipartExampleRequestObject struct

+ Body *multipart.Reader

+ type MultipartExampleResponseObject interface

+ VisitMultipartExampleResponse func(ctx *fiber.Ctx) error

+ type MultipartExampledefaultResponse struct

+ StatusCode int

+ func (response MultipartExampledefaultResponse) VisitMultipartExampleResponse(ctx *fiber.Ctx) error

+ type MultipleRequestAndResponseTypes200FormdataResponse Example

+ func (response MultipleRequestAndResponseTypes200FormdataResponse) VisitMultipleRequestAndResponseTypesResponse(ctx *fiber.Ctx) error

+ type MultipleRequestAndResponseTypes200ImagepngResponse struct

+ Body io.Reader

+ ContentLength int64

+ func (response MultipleRequestAndResponseTypes200ImagepngResponse) VisitMultipleRequestAndResponseTypesResponse(ctx *fiber.Ctx) error

+ type MultipleRequestAndResponseTypes200JSONResponse Example

+ func (response MultipleRequestAndResponseTypes200JSONResponse) VisitMultipleRequestAndResponseTypesResponse(ctx *fiber.Ctx) error

+ type MultipleRequestAndResponseTypes200MultipartResponse func(writer *multipart.Writer) error

+ func (response MultipleRequestAndResponseTypes200MultipartResponse) VisitMultipleRequestAndResponseTypesResponse(ctx *fiber.Ctx) error

+ type MultipleRequestAndResponseTypes200TextResponse string

+ func (response MultipleRequestAndResponseTypes200TextResponse) VisitMultipleRequestAndResponseTypesResponse(ctx *fiber.Ctx) error

+ type MultipleRequestAndResponseTypes400Response = BadrequestResponse

+ func (response MultipleRequestAndResponseTypes400Response) VisitMultipleRequestAndResponseTypesResponse(ctx *fiber.Ctx) error

+ type MultipleRequestAndResponseTypesFormdataRequestBody = Example

+ type MultipleRequestAndResponseTypesJSONRequestBody = Example

+ type MultipleRequestAndResponseTypesMultipartRequestBody = Example

+ type MultipleRequestAndResponseTypesRequestObject struct

+ Body io.Reader

+ FormdataBody *MultipleRequestAndResponseTypesFormdataRequestBody

+ JSONBody *MultipleRequestAndResponseTypesJSONRequestBody

+ MultipartBody *multipart.Reader

+ TextBody *MultipleRequestAndResponseTypesTextRequestBody

+ type MultipleRequestAndResponseTypesResponseObject interface

+ VisitMultipleRequestAndResponseTypesResponse func(ctx *fiber.Ctx) error

+ type MultipleRequestAndResponseTypesTextBody = string

+ type MultipleRequestAndResponseTypesTextRequestBody = MultipleRequestAndResponseTypesTextBody

+ type ReservedGoKeywordParameters200TextResponse string

+ func (response ReservedGoKeywordParameters200TextResponse) VisitReservedGoKeywordParametersResponse(ctx *fiber.Ctx) error

+ type ReservedGoKeywordParametersRequestObject struct

+ Type string

+ type ReservedGoKeywordParametersResponseObject interface

+ VisitReservedGoKeywordParametersResponse func(ctx *fiber.Ctx) error

+ type ReusableResponses200JSONResponse struct

+ func (response ReusableResponses200JSONResponse) VisitReusableResponsesResponse(ctx *fiber.Ctx) error

+ type ReusableResponses400Response = BadrequestResponse

+ func (response ReusableResponses400Response) VisitReusableResponsesResponse(ctx *fiber.Ctx) error

+ type ReusableResponsesJSONRequestBody = Example

+ type ReusableResponsesRequestObject struct

+ Body *ReusableResponsesJSONRequestBody

+ type ReusableResponsesResponseObject interface

+ VisitReusableResponsesResponse func(ctx *fiber.Ctx) error

+ type ReusableResponsesdefaultResponse struct

+ StatusCode int

+ func (response ReusableResponsesdefaultResponse) VisitReusableResponsesResponse(ctx *fiber.Ctx) error

+ type Reusableresponse = Example

+ type ReusableresponseJSONResponse struct

+ Body Example

+ Headers ReusableresponseResponseHeaders

+ type ReusableresponseResponseHeaders struct

+ Header1 string

+ Header2 int

+ type ServerInterface interface

+ HeadersExample func(c *fiber.Ctx, params HeadersExampleParams) error

+ JSONExample func(c *fiber.Ctx) error

+ MultipartExample func(c *fiber.Ctx) error

+ MultipleRequestAndResponseTypes func(c *fiber.Ctx) error

+ ReservedGoKeywordParameters func(c *fiber.Ctx, pType string) error

+ ReusableResponses func(c *fiber.Ctx) error

+ TextExample func(c *fiber.Ctx) error

+ URLEncodedExample func(c *fiber.Ctx) error

+ UnionExample func(c *fiber.Ctx) error

+ UnknownExample func(c *fiber.Ctx) error

+ UnspecifiedContentType func(c *fiber.Ctx) error

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

+ type ServerInterfaceWrapper struct

+ Handler ServerInterface

+ func (siw *ServerInterfaceWrapper) HeadersExample(c *fiber.Ctx) error

+ func (siw *ServerInterfaceWrapper) JSONExample(c *fiber.Ctx) error

+ func (siw *ServerInterfaceWrapper) MultipartExample(c *fiber.Ctx) error

+ func (siw *ServerInterfaceWrapper) MultipleRequestAndResponseTypes(c *fiber.Ctx) error

+ func (siw *ServerInterfaceWrapper) ReservedGoKeywordParameters(c *fiber.Ctx) error

+ func (siw *ServerInterfaceWrapper) ReusableResponses(c *fiber.Ctx) error

+ func (siw *ServerInterfaceWrapper) TextExample(c *fiber.Ctx) error

+ func (siw *ServerInterfaceWrapper) URLEncodedExample(c *fiber.Ctx) error

+ func (siw *ServerInterfaceWrapper) UnionExample(c *fiber.Ctx) error

+ func (siw *ServerInterfaceWrapper) UnknownExample(c *fiber.Ctx) error

+ func (siw *ServerInterfaceWrapper) UnspecifiedContentType(c *fiber.Ctx) error

+ type StrictHandlerFunc func(ctx *fiber.Ctx, args interface{}) (interface{}, error)

+ type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc

+ type StrictServer struct

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

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

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

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

+ func (s StrictServer) ReservedGoKeywordParameters(ctx context.Context, request ReservedGoKeywordParametersRequestObject) (ReservedGoKeywordParametersResponseObject, error)

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

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

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

+ func (s StrictServer) UnionExample(ctx context.Context, request UnionExampleRequestObject) (UnionExampleResponseObject, error)

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

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

+ type StrictServerInterface interface

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

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

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

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

+ ReservedGoKeywordParameters func(ctx context.Context, request ReservedGoKeywordParametersRequestObject) (ReservedGoKeywordParametersResponseObject, error)

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

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

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

+ UnionExample func(ctx context.Context, request UnionExampleRequestObject) (UnionExampleResponseObject, error)

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

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

+ type TextExample200TextResponse string

+ func (response TextExample200TextResponse) VisitTextExampleResponse(ctx *fiber.Ctx) error

+ type TextExample400Response = BadrequestResponse

+ func (response TextExample400Response) VisitTextExampleResponse(ctx *fiber.Ctx) error

+ type TextExampleRequestObject struct

+ Body *TextExampleTextRequestBody

+ type TextExampleResponseObject interface

+ VisitTextExampleResponse func(ctx *fiber.Ctx) error

+ type TextExampleTextBody = string

+ type TextExampleTextRequestBody = TextExampleTextBody

+ type TextExampledefaultResponse struct

+ StatusCode int

+ func (response TextExampledefaultResponse) VisitTextExampleResponse(ctx *fiber.Ctx) error

+ type URLEncodedExample200FormdataResponse Example

+ func (response URLEncodedExample200FormdataResponse) VisitURLEncodedExampleResponse(ctx *fiber.Ctx) error

+ type URLEncodedExample400Response = BadrequestResponse

+ func (response URLEncodedExample400Response) VisitURLEncodedExampleResponse(ctx *fiber.Ctx) error

+ type URLEncodedExampleFormdataRequestBody = Example

+ type URLEncodedExampleRequestObject struct

+ Body *URLEncodedExampleFormdataRequestBody

+ type URLEncodedExampleResponseObject interface

+ VisitURLEncodedExampleResponse func(ctx *fiber.Ctx) error

+ type URLEncodedExampledefaultResponse struct

+ StatusCode int

+ func (response URLEncodedExampledefaultResponse) VisitURLEncodedExampleResponse(ctx *fiber.Ctx) error

+ type UnionExample200JSONResponse struct

+ Body struct{}

+ Headers UnionExample200ResponseHeaders

+ func (response UnionExample200JSONResponse) VisitUnionExampleResponse(ctx *fiber.Ctx) error

+ type UnionExample200ResponseHeaders struct

+ Header1 string

+ Header2 int

+ type UnionExample400Response = BadrequestResponse

+ func (response UnionExample400Response) VisitUnionExampleResponse(ctx *fiber.Ctx) error

+ type UnionExampleJSONRequestBody = Example

+ type UnionExampleRequestObject struct

+ Body *UnionExampleJSONRequestBody

+ type UnionExampleResponseObject interface

+ VisitUnionExampleResponse func(ctx *fiber.Ctx) error

+ type UnionExampledefaultResponse struct

+ StatusCode int

+ func (response UnionExampledefaultResponse) VisitUnionExampleResponse(ctx *fiber.Ctx) error

+ type UnknownExample200Videomp4Response struct

+ Body io.Reader

+ ContentLength int64

+ func (response UnknownExample200Videomp4Response) VisitUnknownExampleResponse(ctx *fiber.Ctx) error

+ type UnknownExample400Response = BadrequestResponse

+ func (response UnknownExample400Response) VisitUnknownExampleResponse(ctx *fiber.Ctx) error

+ type UnknownExampleRequestObject struct

+ Body io.Reader

+ type UnknownExampleResponseObject interface

+ VisitUnknownExampleResponse func(ctx *fiber.Ctx) error

+ type UnknownExampledefaultResponse struct

+ StatusCode int

+ func (response UnknownExampledefaultResponse) VisitUnknownExampleResponse(ctx *fiber.Ctx) error

+ type UnspecifiedContentType200VideoResponse struct

+ Body io.Reader

+ ContentLength int64

+ ContentType string

+ func (response UnspecifiedContentType200VideoResponse) VisitUnspecifiedContentTypeResponse(ctx *fiber.Ctx) error

+ type UnspecifiedContentType400Response = BadrequestResponse

+ func (response UnspecifiedContentType400Response) VisitUnspecifiedContentTypeResponse(ctx *fiber.Ctx) error

+ type UnspecifiedContentType401Response struct

+ func (response UnspecifiedContentType401Response) VisitUnspecifiedContentTypeResponse(ctx *fiber.Ctx) error

+ type UnspecifiedContentType403Response struct

+ func (response UnspecifiedContentType403Response) VisitUnspecifiedContentTypeResponse(ctx *fiber.Ctx) error

+ type UnspecifiedContentTypeRequestObject struct

+ Body io.Reader

+ ContentType string

+ type UnspecifiedContentTypeResponseObject interface

+ VisitUnspecifiedContentTypeResponse func(ctx *fiber.Ctx) error

+ type UnspecifiedContentTypedefaultResponse struct

+ StatusCode int

+ func (response UnspecifiedContentTypedefaultResponse) VisitUnspecifiedContentTypeResponse(ctx *fiber.Ctx) error