api

Documentation

Overview

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.0.0-00010101000000-000000000000 DO NOT EDIT.

Index

• func RegisterHandlers(router fiber.Router, si ServerInterface)
• func RegisterHandlersWithOptions(router fiber.Router, si ServerInterface, options FiberServerOptions)
• type FiberServerOptions
• type MiddlewareFunc
• type Pong
• type Server
  • func NewServer() Server
  • func (Server) GetPing(ctx *fiber.Ctx) error
• type ServerInterface
• type ServerInterfaceWrapper
  • func (siw *ServerInterfaceWrapper) GetPing(c *fiber.Ctx) error

Functions

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 FiberServerOptions

type FiberServerOptions struct {
	BaseURL     string
	Middlewares []MiddlewareFunc
}

FiberServerOptions provides options for the Fiber server.

type MiddlewareFunc

type MiddlewareFunc fiber.Handler

type Pong

type Pong struct {
	Ping string `json:"ping"`
}

Pong defines model for Pong.

type Server

type Server struct{}

func NewServer

func NewServer() Server

func (Server) GetPing

func (Server) GetPing(ctx *fiber.Ctx) error

(GET /ping)

type ServerInterface

type ServerInterface interface {

	// (GET /ping)
	GetPing(c *fiber.Ctx) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) GetPing

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

GetPing operation middleware