routers

package
v0.0.0-...-114ffcd Latest Latest
Warning

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

Go to latest
Published: Mar 16, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

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

Code generated by github.com/deepmap/oapi-codegen/v2 version v2.1.0 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 fiber.Router, si ServerInterface)

RegisterHandlers creates http.Handler with routing matching OpenAPI spec.

func RegisterHandlersWithOptions

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

RegisterHandlersWithOptions creates http.Handler with additional options

Types

type BookId

type BookId struct {
	Id *openapi_types.UUID `json:"id,omitempty"`
}

BookId defines model for BookId.

type Booking

type Booking = models.Booking

Booking defines model for Booking.

type CreateBooking200JSONResponse

type CreateBooking200JSONResponse BookId

func (CreateBooking200JSONResponse) VisitCreateBookingResponse

func (response CreateBooking200JSONResponse) VisitCreateBookingResponse(ctx *fiber.Ctx) error

type CreateBookingJSONRequestBody

type CreateBookingJSONRequestBody = Booking

CreateBookingJSONRequestBody defines body for CreateBooking for application/json ContentType.

type CreateBookingParams

type CreateBookingParams struct {
	// Offset The number of items to skip before starting to collect the result
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// Limit The numbers of items to return
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

CreateBookingParams defines parameters for CreateBooking.

type CreateBookingRequestObject

type CreateBookingRequestObject struct {
	Params CreateBookingParams
	Body   *CreateBookingJSONRequestBody
}

type CreateBookingResponseObject

type CreateBookingResponseObject interface {
	VisitCreateBookingResponse(ctx *fiber.Ctx) error
}

type CreateBookingdefaultJSONResponse

type CreateBookingdefaultJSONResponse struct {
	Body       Error
	StatusCode int
}

func (CreateBookingdefaultJSONResponse) VisitCreateBookingResponse

func (response CreateBookingdefaultJSONResponse) VisitCreateBookingResponse(ctx *fiber.Ctx) error

type DeleteBookingById204Response

type DeleteBookingById204Response struct {
}

func (DeleteBookingById204Response) VisitDeleteBookingByIdResponse

func (response DeleteBookingById204Response) VisitDeleteBookingByIdResponse(ctx *fiber.Ctx) error

type DeleteBookingByIdRequestObject

type DeleteBookingByIdRequestObject struct {
	BookId string `json:"BookId"`
}

type DeleteBookingByIdResponseObject

type DeleteBookingByIdResponseObject interface {
	VisitDeleteBookingByIdResponse(ctx *fiber.Ctx) error
}

type DeleteBookingByIddefaultJSONResponse

type DeleteBookingByIddefaultJSONResponse struct {
	Body       Error
	StatusCode int
}

func (DeleteBookingByIddefaultJSONResponse) VisitDeleteBookingByIdResponse

func (response DeleteBookingByIddefaultJSONResponse) VisitDeleteBookingByIdResponse(ctx *fiber.Ctx) error

type Error

type Error struct {
	// Code Error code that identify of the error
	Code *int32 `json:"code,omitempty"`

	// Message Short description of the error
	Message *string `json:"message,omitempty"`
}

Error Object representing an error

type FiberServerOptions

type FiberServerOptions struct {
	BaseURL     string
	Middlewares []MiddlewareFunc
}

FiberServerOptions provides options for the Fiber server.

type GetAllBooking200JSONResponse

type GetAllBooking200JSONResponse []Booking

func (GetAllBooking200JSONResponse) VisitGetAllBookingResponse

func (response GetAllBooking200JSONResponse) VisitGetAllBookingResponse(ctx *fiber.Ctx) error

type GetAllBookingParams

type GetAllBookingParams struct {
	// Offset The number of items to skip before starting to collect the result
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// Limit The numbers of items to return
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

GetAllBookingParams defines parameters for GetAllBooking.

type GetAllBookingRequestObject

type GetAllBookingRequestObject struct {
	Params GetAllBookingParams
}

type GetAllBookingResponseObject

type GetAllBookingResponseObject interface {
	VisitGetAllBookingResponse(ctx *fiber.Ctx) error
}

type GetAllBookingdefaultJSONResponse

type GetAllBookingdefaultJSONResponse struct {
	Body       Error
	StatusCode int
}

func (GetAllBookingdefaultJSONResponse) VisitGetAllBookingResponse

func (response GetAllBookingdefaultJSONResponse) VisitGetAllBookingResponse(ctx *fiber.Ctx) error

type GetBookingById200JSONResponse

type GetBookingById200JSONResponse Booking

func (GetBookingById200JSONResponse) VisitGetBookingByIdResponse

func (response GetBookingById200JSONResponse) VisitGetBookingByIdResponse(ctx *fiber.Ctx) error

type GetBookingByIdRequestObject

type GetBookingByIdRequestObject struct {
	BookId string `json:"BookId"`
}

type GetBookingByIdResponseObject

type GetBookingByIdResponseObject interface {
	VisitGetBookingByIdResponse(ctx *fiber.Ctx) error
}

type GetBookingByIddefaultJSONResponse

type GetBookingByIddefaultJSONResponse struct {
	Body       Error
	StatusCode int
}

func (GetBookingByIddefaultJSONResponse) VisitGetBookingByIdResponse

func (response GetBookingByIddefaultJSONResponse) VisitGetBookingByIdResponse(ctx *fiber.Ctx) error

type GetBookingByUserId200JSONResponse

type GetBookingByUserId200JSONResponse []Booking

func (GetBookingByUserId200JSONResponse) VisitGetBookingByUserIdResponse

func (response GetBookingByUserId200JSONResponse) VisitGetBookingByUserIdResponse(ctx *fiber.Ctx) error

type GetBookingByUserIdRequestObject

type GetBookingByUserIdRequestObject struct {
	UserId string `json:"UserId"`
}

type GetBookingByUserIdResponseObject

type GetBookingByUserIdResponseObject interface {
	VisitGetBookingByUserIdResponse(ctx *fiber.Ctx) error
}

type GetBookingByUserIddefaultJSONResponse

type GetBookingByUserIddefaultJSONResponse struct {
	Body       Error
	StatusCode int
}

func (GetBookingByUserIddefaultJSONResponse) VisitGetBookingByUserIdResponse

func (response GetBookingByUserIddefaultJSONResponse) VisitGetBookingByUserIdResponse(ctx *fiber.Ctx) error

type MiddlewareFunc

type MiddlewareFunc fiber.Handler

type ServerInterface

type ServerInterface interface {
	// Get All Booking
	// (GET /v1/booking)
	GetAllBooking(c *fiber.Ctx, params GetAllBookingParams) error
	// Create Booking
	// (POST /v1/booking)
	CreateBooking(c *fiber.Ctx, params CreateBookingParams) error
	// Get Booking by UserId
	// (GET /v1/booking/user/{UserId})
	GetBookingByUserId(c *fiber.Ctx, userId string) error
	// Delete Booking By Booking Id
	// (DELETE /v1/booking/{BookId})
	DeleteBookingById(c *fiber.Ctx, bookId string) error
	// Get Booking by Booking Id
	// (GET /v1/booking/{BookId})
	GetBookingById(c *fiber.Ctx, bookId string) error
	// Update Booking By Booking Id
	// (PUT /v1/booking/{BookId})
	UpdateBookingById(c *fiber.Ctx, bookId string) error
}

ServerInterface represents all server handlers.

func NewStrictHandler

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

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) CreateBooking

func (siw *ServerInterfaceWrapper) CreateBooking(c *fiber.Ctx) error

CreateBooking operation middleware

func (*ServerInterfaceWrapper) DeleteBookingById

func (siw *ServerInterfaceWrapper) DeleteBookingById(c *fiber.Ctx) error

DeleteBookingById operation middleware

func (*ServerInterfaceWrapper) GetAllBooking

func (siw *ServerInterfaceWrapper) GetAllBooking(c *fiber.Ctx) error

GetAllBooking operation middleware

func (*ServerInterfaceWrapper) GetBookingById

func (siw *ServerInterfaceWrapper) GetBookingById(c *fiber.Ctx) error

GetBookingById operation middleware

func (*ServerInterfaceWrapper) GetBookingByUserId

func (siw *ServerInterfaceWrapper) GetBookingByUserId(c *fiber.Ctx) error

GetBookingByUserId operation middleware

func (*ServerInterfaceWrapper) UpdateBookingById

func (siw *ServerInterfaceWrapper) UpdateBookingById(c *fiber.Ctx) error

UpdateBookingById operation middleware

type StrictHandlerFunc

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

type StrictMiddlewareFunc

type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc

type StrictServerInterface

type StrictServerInterface interface {
	// Get All Booking
	// (GET /v1/booking)
	GetAllBooking(ctx context.Context, request GetAllBookingRequestObject) (GetAllBookingResponseObject, error)
	// Create Booking
	// (POST /v1/booking)
	CreateBooking(ctx context.Context, request CreateBookingRequestObject) (CreateBookingResponseObject, error)
	// Get Booking by UserId
	// (GET /v1/booking/user/{UserId})
	GetBookingByUserId(ctx context.Context, request GetBookingByUserIdRequestObject) (GetBookingByUserIdResponseObject, error)
	// Delete Booking By Booking Id
	// (DELETE /v1/booking/{BookId})
	DeleteBookingById(ctx context.Context, request DeleteBookingByIdRequestObject) (DeleteBookingByIdResponseObject, error)
	// Get Booking by Booking Id
	// (GET /v1/booking/{BookId})
	GetBookingById(ctx context.Context, request GetBookingByIdRequestObject) (GetBookingByIdResponseObject, error)
	// Update Booking By Booking Id
	// (PUT /v1/booking/{BookId})
	UpdateBookingById(ctx context.Context, request UpdateBookingByIdRequestObject) (UpdateBookingByIdResponseObject, error)
}

StrictServerInterface represents all server handlers.

type UpdateBookingById200JSONResponse

type UpdateBookingById200JSONResponse BookId

func (UpdateBookingById200JSONResponse) VisitUpdateBookingByIdResponse

func (response UpdateBookingById200JSONResponse) VisitUpdateBookingByIdResponse(ctx *fiber.Ctx) error

type UpdateBookingByIdJSONRequestBody

type UpdateBookingByIdJSONRequestBody = Booking

UpdateBookingByIdJSONRequestBody defines body for UpdateBookingById for application/json ContentType.

type UpdateBookingByIdRequestObject

type UpdateBookingByIdRequestObject struct {
	BookId string `json:"BookId"`
	Body   *UpdateBookingByIdJSONRequestBody
}

type UpdateBookingByIdResponseObject

type UpdateBookingByIdResponseObject interface {
	VisitUpdateBookingByIdResponse(ctx *fiber.Ctx) error
}

type UpdateBookingByIddefaultJSONResponse

type UpdateBookingByIddefaultJSONResponse struct {
	Body       Error
	StatusCode int
}

func (UpdateBookingByIddefaultJSONResponse) VisitUpdateBookingByIdResponse

func (response UpdateBookingByIddefaultJSONResponse) VisitUpdateBookingByIdResponse(ctx *fiber.Ctx) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL