docs

package

v0.29.5 Latest Latest Go to latest Published: Nov 26, 2025 License: MIT Imports: 3 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type DocsHandler struct {
	DocsFS      embed.FS
	SwaggerUIFS embed.FS
}

DocsHandler handles all documentation and Swagger UI endpoints

func (h *DocsHandler) GetOpenAPIYAML(c echo.Context) error

GetOpenAPIYAML serves the openapi.yaml file

func (h *DocsHandler) GetSwaggerJSON(c echo.Context) error

GetSwaggerJSON serves the swagger.json file

func (h *DocsHandler) GetSwaggerUI(c echo.Context) error

GetSwaggerUI serves the Swagger UI HTML page

func (h *DocsHandler) GetSwaggerUIBundle(c echo.Context) error

GetSwaggerUIBundle serves the Swagger UI bundle JavaScript

func (h *DocsHandler) GetSwaggerUICSS(c echo.Context) error

GetSwaggerUICSS serves the Swagger UI CSS file

func (h *DocsHandler) GetSwaggerUIPreset(c echo.Context) error

GetSwaggerUIPreset serves the Swagger UI standalone preset JavaScript