simbaOpenapi

Documentation

Index

• func GetReflector() (*openapi31.Reflector, error)
• func ScalarDocsHandler(params DocsParams) http.HandlerFunc
• type DocsParams
• type OpenAPIGenerator
  • func NewOpenAPIGenerator() *OpenAPIGenerator
  • func (g *OpenAPIGenerator) GenerateDocumentation(_ context.Context, title string, version string, ...) ([]byte, error)

Functions

func GetReflector

func GetReflector() (*openapi31.Reflector, error)

GetReflector creates a new OpenAPI reflector with custom options

func ScalarDocsHandler

func ScalarDocsHandler(params DocsParams) http.HandlerFunc

ScalarDocsHandler returns a handler that serves the API documentation using the Scalar API Reference component.

Types

type DocsParams

type DocsParams struct {
	OpenAPIFileType string
	OpenAPIPath     string
	DocsPath        string
	ServiceName     string
}

type OpenAPIGenerator

type OpenAPIGenerator struct {
}

func NewOpenAPIGenerator

func NewOpenAPIGenerator() *OpenAPIGenerator

func (*OpenAPIGenerator) GenerateDocumentation

func (g *OpenAPIGenerator) GenerateDocumentation(_ context.Context, title string, version string, routeInfos []openapiModels.RouteInfo) ([]byte, error)

GenerateDocumentation generates OpenAPI documentation for all routes