openapi

Documentation

Overview

Package openapi GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE

Index

• Variables
• func FromRouter(r courier.Router, fns ...BuildOptionFunc) *openapi.OpenAPI
• type BuildOptionFunc
  • func Naming(naming func(t string) string) BuildOptionFunc
  • func (BuildOptionFunc) RuntimeDoc(names ...string) ([]string, bool)
• type CanResponseContent
• type CanResponseContentType
• type CanResponseErrors
• type CanResponseStatusCode
• type CanRuntimeDoc
• type OpenAPIBuildFunc
  • func (OpenAPIBuildFunc) RuntimeDoc(names ...string) ([]string, bool)

Variables

var DefaultOpenAPIBuildFunc = func(r courier.Router, fns ...BuildOptionFunc) *openapi.OpenAPI {
	if v, ok := cached.Load(r); ok {
		return v.(*openapi.OpenAPI)
	}
	o := FromRouter(r, fns...)
	cached.Store(r, o)
	return o
}

Functions

func FromRouter

func FromRouter(r courier.Router, fns ...BuildOptionFunc) *openapi.OpenAPI

Types

type BuildOptionFunc

type BuildOptionFunc func(o *buildOption)

func Naming

func Naming(naming func(t string) string) BuildOptionFunc

func (BuildOptionFunc) RuntimeDoc

func (BuildOptionFunc) RuntimeDoc(names ...string) ([]string, bool)

type CanResponseContent

type CanResponseContent interface {
	ResponseContent() any
}

type CanResponseContentType

type CanResponseContentType interface {
	ResponseContentType() string
}

type CanResponseErrors

type CanResponseErrors interface {
	ResponseErrors() []error
}

type CanResponseStatusCode

type CanResponseStatusCode interface {
	ResponseStatusCode() int
}

type CanRuntimeDoc

type CanRuntimeDoc interface {
	RuntimeDoc(names ...string) ([]string, bool)
}

type OpenAPIBuildFunc

type OpenAPIBuildFunc func(r courier.Router, fns ...BuildOptionFunc) *openapi.OpenAPI

func (OpenAPIBuildFunc) RuntimeDoc

func (OpenAPIBuildFunc) RuntimeDoc(names ...string) ([]string, bool)