openapi

package

v0.1.6 Latest Latest Go to latest Published: Sep 8, 2026 License: MIT Imports: 13 Imported by: 0

Details

This section is empty.

This section is empty.

func Generate(svc *service.Definition) (*openapi3.T, error)

Generate builds a validated OpenAPI 3.1.0 document from a Service Definition.

func GenerateJSON(svc *service.Definition, pretty bool) ([]byte, error)

GenerateJSON serializes the OpenAPI 3.1 specification to JSON.

func GenerateYAML(svc *service.Definition) ([]byte, error)

GenerateYAML converts the specification into clean YAML.

func RenderHTML(renderer, customTemplate string, data TemplateData) ([]byte, error)

RenderHTML generates the HTML page for a documentation UI renderer or custom template.

type TemplateData struct {
	Title       string
	Version     string
	Description string
	SpecURL     string
	SpecYAMLURL string
}

TemplateData holds template context data for OpenAPI HTML documentation viewers.