API reference components

Composable endpoint, parameter, request, and response primitives for product-owned APIs.

On this page

Endpoint

Present the HTTP method, path, and concise operation description.

let endpoint =
    docsApiEndpoint
        POST
        "/v1/customers"
        "Creates a customer and returns its identifier."

Parameters

Describe required and optional values with compact names, types, and explanations.

let parameters =
    docsParameters [
        docsParameter "email" "string" true "Customer email address."
        docsParameter "metadata" "object" false "Application-defined values." ]

Request and response examples

Keep realistic request source and response payloads visually paired.

let requestSource = "curl -X POST https://api.example.test/v1/customers"
let responseSource = "{ \"id\": \"cus_123\" }"
let requestResponse =
    div {
        _class "docs-showcase-panels"
        docsCodeExample "Create customer" "curl" requestSource
        docsResponseExample "201" "json" responseSource
    }