handlers

Documentation

Index

• Constants
• func HealthCheckHandler(c *fiber.Ctx) error
• func RenderBundleHandler(c *fiber.Ctx) error
• func RenderPdfFromHtmlFromTemplateHandler(c *fiber.Ctx) error
• func RenderPdfFromHtmlHandler(c *fiber.Ctx) error
• func TestHtmlTemplateHandler(c *fiber.Ctx) error

Constants

const TemplateEngineQueryKey = "template-engine"

Functions

func HealthCheckHandler

func HealthCheckHandler(c *fiber.Ctx) error

Health Endpoint (liveness) godoc @Summary Liveness probe for this service @Tags Internals @Accept multipart/form-data @Produce text/plain @Success 200 @Router /health [get]

func RenderBundleHandler

func RenderBundleHandler(c *fiber.Ctx) error

RenderBundleHandler godoc @Summary Render PDF from bundle including HTML(-Template) with model and assets provided in form-data (keys: bundle, model) @Description Returns PDF file generated from bundle (Zip-File) of HTML or HTML template of body, header, footer and assets. The index.html file in the Zip-Bundle is required @Tags Render HTML-Bundle @Accept multipart/form-data @Produce application/pdf @Param bundle formData file true "Bundle Zip-File" @Param model formData string false "JSON-Model for template (only required for template)" @Param templateEngine formData string false "Template engine to use for template (only required for template)" @Success 200 "PDF File" @Router /api/pdf/from/html-bundle/render [post]

func RenderPdfFromHtmlFromTemplateHandler

func RenderPdfFromHtmlFromTemplateHandler(c *fiber.Ctx) error

RenderPdfFromHtmlFromTemplateHandler godoc @Summary Render PDF from HTML template @Description Returns PDF file generated from HTML template plus model of body, header and footer @Tags Render HTML-Template @Accept json @Produce application/pdf @Param renderTemplateData body models.RenderTemplateData true "Render Data" @Success 200 "PDF File" @Router /api/pdf/from/html-template/render [post]

func RenderPdfFromHtmlHandler

func RenderPdfFromHtmlHandler(c *fiber.Ctx) error

RenderPdfFromHtmlHandler godoc @Summary Render PDF from HTML @Description Returns PDF file generated from HTML of body, header and footer @Tags Render HTML @Accept json @Produce application/pdf @Param renderData body models.RenderData true "Render Data" @Success 200 "PDF File" @Router /api/pdf/from/html/render [post]

func TestHtmlTemplateHandler

func TestHtmlTemplateHandler(c *fiber.Ctx) error

TestHtmlTemplateHandler godoc @Summary Test HTML template matching model @Description Returns information about matching model data to template @Tags Render HTML-Template @Accept json @Produce json @Param renderTemplateData body models.RenderTemplateData true "Render Data" @Success 200 {object} dto.TemplateTestResult @Router /api/pdf/from/html-template/test [post]