GitHub

API reference for scalar.

Scalar API reference for an HttpApi (Effect's HttpApiScalar): layer(api) serves it at GET /docs with Scalar bundled, layer_cdn(api) loads Scalar from jsDelivr. The page is made on the first request and kept.

Types

TypeDefinitionDescription
ScalarThemeIdtype ScalarThemeId = Literal['alternate', 'default', 'moon', 'purple', 'solarized', 'bluePlanet', 'saturn', 'kepler', 'mars', 'deepSpace', 'laserwave', 'none']

Classes

Functions

layer

layer(api, *, path='/docs', scalar=None) -> Layer[Never, Never, HttpRouter]

GET path answering with the Scalar reference of api, Scalar bundled in the page.

ParameterTypeDescription
apiHttpApi[Any]
pathstr = '/docs'
scalarScalarConfig | None = None

Returns Layer[Never, Never, HttpRouter]

def layer(
    api: HttpApi[Any], *, path: str = "/docs", scalar: ScalarConfig | None = None
) -> Layer[Never, Never, HttpRouter]:
    """``GET path`` answering with the Scalar reference of ``api``, Scalar
    bundled in the page."""
    return _serve(api, path, sync(lambda: f"<script>{_html.asset('scalar.js')}</script>"), scalar)

layer_cdn

layer_cdn(api, *, path='/docs', scalar=None, version='latest') -> Layer[Never, Never, HttpRouter]

layer loading Scalar version from jsDelivr.

ParameterTypeDescription
apiHttpApi[Any]
pathstr = '/docs'
scalarScalarConfig | None = None
versionstr = 'latest'

Returns Layer[Never, Never, HttpRouter]

def layer_cdn(
    api: HttpApi[Any],
    *,
    path: str = "/docs",
    scalar: ScalarConfig | None = None,
    version: str = "latest",
) -> Layer[Never, Never, HttpRouter]:
    """``layer`` loading Scalar ``version`` from jsDelivr."""
    source = (
        "https://cdn.jsdelivr.net/npm/@scalar/api-reference@"
        f"{quote(version, safe="-_.!~*'()")}/dist/browser/standalone.min.js"
    )
    script = f'<script src="{_html.escape_attribute(source)}" crossorigin></script>'
    return _serve(api, path, sync(lambda: script), scalar)