openapi

package

v0.1.1 Latest Latest Go to latest Published: Sep 2, 2026 License: MIT Imports: 16 Imported by: 0

Details

This section is empty.

This section is empty.

func Generate(service *compiler.CompiledService) (*openapi3.T, error)

Generate builds a validated OpenAPI 3.1.0 document from a CompiledService.

func GenerateJSON(service *compiler.CompiledService, pretty bool) ([]byte, error)

GenerateJSON serializes the OpenAPI 3.1 specification to formatted JSON.

func GenerateYAML(service *compiler.CompiledService) ([]byte, error)

GenerateYAML converts the canonical JSON representation into YAML to preserve custom kin-openapi tags.

func RenderHTML(ui string, data TemplateData, rawTemplate, templateFile, manifestDir string) ([]byte, error)

RenderHTML generates the HTML page for the selected interactive documentation renderer.

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

TemplateData holds view context data for OpenAPI HTML renderers.