gocrew

Documentation

Index

• func P[T any](v T) *T
• func Walk(r chi.Routes, walkFn WalkFunc, onController ControllerFunc) error
• type ControllerFunc
• type Generator
  • func OpenApi31(title string, defaultTag *openapi31.Tag) Generator[OpenApi31Spec]
• type OpenApi31Spec
  • func (spec *OpenApi31Spec) ServeHTTP(w http.ResponseWriter, _ *http.Request)
  • func (spec *OpenApi31Spec) WithUI(title string, basePath string, docPattern string, config *swg.Config) http.Handler
• type WalkFunc

Functions

func P

func P[T any](v T) *T

P wraps the value to a pointer

func Walk

func Walk(r chi.Routes, walkFn WalkFunc, onController ControllerFunc) error

Types

type ControllerFunc

type ControllerFunc func(controller goflag.ControllerFlag) error

type Generator

type Generator[T any] interface {
	Generate(router chi.Routes) (*T, error)
}

Generator generates a T documentation from a chi.Router

func OpenApi31

func OpenApi31(title string, defaultTag *openapi31.Tag) Generator[OpenApi31Spec]

OpenApi31 returns a Generator that generates a OpenAPI v3.1.0 compliant specification

type OpenApi31Spec

type OpenApi31Spec openapi31.Spec

func (*OpenApi31Spec) ServeHTTP

func (spec *OpenApi31Spec) ServeHTTP(w http.ResponseWriter, _ *http.Request)

func (*OpenApi31Spec) WithUI

func (spec *OpenApi31Spec) WithUI(title string, basePath string, docPattern string, config *swg.Config) http.Handler

type WalkFunc

type WalkFunc func(method string, route string, handler http.Handler, controller goflag.ControllerFlag) error