Skip to main content

API reference page

A complete reference composition with endpoint documentation and a dedicated request-response rail.

On this page

About this page example

FSharp.ViewEngine does not expose an HTTP /v1/render endpoint. The fictional operation keeps the example focused on docsReference and the reusable API components.

Render endpoint reference
let endpoint = docsApiEndpoint POST "/v1/render" "Renders an HTML element."
let parameters = docsParameters [ docsParameter "view" "string" true "Typed view source." ]
let rail =
    div {
        docsCodeExample "Render a view" "fsharp" "Render.toString view"
        docsResponseExample "200" "html" "<main>Rendered view</main>" }
let apiPage =
    docsReference "render" "Render a view" "Rendering reference." [
        docsSection "endpoint" "Endpoint" [ docsCustom endpoint ]
        docsSection "parameters" "Parameters" [ docsCustom parameters ] ]
        (docsRail rail)