openapi

Documentation

Index

• func ConvertSwaggerToOpenAPI(swaggerPath, outPath string) error
• func GenerateSwagDocsContent(routes []Route) string
• func LoadOpenAPI(path string) (*openapi3.T, error)
• func NormalizeEchoPath(path string) string
• func PatchSecuritySchemes(doc *openapi3.T)
• func ValidateRouteCoverage(doc *openapi3.T, routes []Route) error
• type Route
  • func RegisteredRoutes() ([]Route, error)

Functions

func ConvertSwaggerToOpenAPI

func ConvertSwaggerToOpenAPI(swaggerPath, outPath string) error

ConvertSwaggerToOpenAPI converts a swagger v2 file produced by swag into OpenAPI 3 and normalizes the security schemes for MCP consumption.

func GenerateSwagDocsContent

func GenerateSwagDocsContent(routes []Route) string

GenerateSwagDocsContent returns the generated Swag annotations used as input to swag init.

func LoadOpenAPI

func LoadOpenAPI(path string) (*openapi3.T, error)

LoadOpenAPI loads an OpenAPI 3 document from disk.

func NormalizeEchoPath

func NormalizeEchoPath(path string) string

NormalizeEchoPath converts Echo route params (:id) to OpenAPI params ({id}).

func PatchSecuritySchemes

func PatchSecuritySchemes(doc *openapi3.T)

PatchSecuritySchemes rewrites the generated schemes into explicit bearer schemes.

func ValidateRouteCoverage

func ValidateRouteCoverage(doc *openapi3.T, routes []Route) error

ValidateRouteCoverage ensures every registered route is present in the OpenAPI document.

Types

type Route

type Route struct {
	Method     string
	Path       string
	Parameters []string
}

Route is the normalized route shape used by the OpenAPI tooling.

func RegisteredRoutes

func RegisteredRoutes() ([]Route, error)

RegisteredRoutes returns the full HTTP surface registered by the Echo server.