meta

Documentation

Index

• Variables
• func GenerateOpenAPI() []byte
• func Register(metas ...RouteMeta)
• func Reset()
• func ScalarUIHTML(jsonURL string) string
• func SwaggerUIHTML(jsonURL string) string
• type RouteMeta
  • func All() []RouteMeta

Variables

var ScalarUITemplate string

var SwaggerUITemplate string

Functions

func GenerateOpenAPI

func GenerateOpenAPI() []byte

GenerateOpenAPI generates an OpenAPI 3.0 JSON specification from all registered route metadata.

func Register

func Register(metas ...RouteMeta)

Register adds or updates one or more RouteMeta entries in the radix tree. If a route with the same Method+Path already exists, its fields are merged (non-zero fields in the new entry override the existing ones). This allows Handle() to register basic metadata (method, path) first, and contract-based Mount() to enrich it later with ReqType/RespType/Tag.

func Reset

func Reset()

Reset clears all registered metadata. Useful for testing.

func ScalarUIHTML

func ScalarUIHTML(jsonURL string) string

ScalarUIHTML returns the Scalar API Reference HTML page pointing to the given openapi.json URL.

func SwaggerUIHTML

func SwaggerUIHTML(jsonURL string) string

SwaggerUIHTML returns the Swagger UI HTML page pointing to the given openapi.json URL.

Types

type RouteMeta

type RouteMeta struct {
	Method   string
	Path     string
	ReqType  reflect.Type
	RespType reflect.Type
	Tag      string // using for service name => open api tag
}

RouteMeta holds metadata for a registered route, useful for generating OpenAPI documentation.

func All

func All() []RouteMeta

All returns all registered route metadata by traversing the radix trees.