Swagger UI for an HttpApi (Effect's HttpApiSwagger)::
app = builder.layer(api).pipe(layer.merge(swagger.layer(api)))serves the API's OpenAPI document in Swagger UI at GET /docs. The page
bundles Swagger UI, so it needs no network; it is made on the first
request and kept.
Functions#
layer#
layer(api, *, path='/docs') -> Layer[Never, Never, HttpRouter]GET path answering with Swagger UI for api.
| Parameter | Type | Description |
|---|---|---|
api | HttpApi[Any] | |
path | str = '/docs' |
Returns Layer[Never, Never, HttpRouter]
def layer(api: HttpApi[Any], *, path: str = "/docs") -> Layer[Never, Never, HttpRouter]:
"""``GET path`` answering with Swagger UI for ``api``."""
def add(router: HttpRouterService) -> Effect[None]:
def with_assets(assets: tuple[str, str]) -> Effect[None]:
javascript, css = assets
page = _html.memoize_success(lambda: _page(api, javascript, css))
return router.add("GET", path, sync(page))
return sync(lambda: (_html.asset("swagger-ui.js"), _html.asset("swagger-ui.css"))).flat_map(
with_assets
)
return use(add)