explicit_nullable

Documentation

Overview

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

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

Index

• func RegisterHandlers(router EchoRouter, si ServerInterface, m ...echo.MiddlewareFunc)
• func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string, ...)
• type EchoRouter
• type Entity
• type FooResponse
• type Response
• type ServerInterface
• type ServerInterfaceWrapper
  • func (w *ServerInterfaceWrapper) Foo(ctx echo.Context) error

Functions

func RegisterHandlers

func RegisterHandlers(router EchoRouter, si ServerInterface, m ...echo.MiddlewareFunc)

RegisterHandlers adds each server route to the EchoRouter.

func RegisterHandlersWithBaseURL

func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string, m ...echo.MiddlewareFunc)

Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.

Types

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 Entity

type Entity struct {
	IntField            int     `json:"int_field" validate:"required"`
	IntFieldNullable    *int    `json:"int_field_nullable,omitempty"`
	StringField         string  `json:"string_field" validate:"required"`
	StringFieldNullable *string `json:"string_field_nullable,omitempty"`
}

Entity defines model for Entity.

type FooResponse

type FooResponse struct {
	Code    int
	JSON200 *Entity
}

type Response

type Response = Entity

Response defines model for Response.

type ServerInterface

type ServerInterface interface {

	// (GET /foo)
	Foo(ctx echo.Context) (resp *FooResponse, err error)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) Foo

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

Foo converts echo context to params.