alepha@docs:~/framework/docs/packages/@alepha-ui$
cat swagger.md | pretty
1 min read
Last commit:

#@alepha/ui - Swagger

#Installation

npm install @alepha/ui

#Overview

The API explorer.

$uiSwagger mounts a page that reads the app's OpenAPI document (served by $swagger from alepha/server/swagger) and renders it with @alepha/ui: operations by tag with a search, each in full with its schemas and the x-alepha-* metadata Alepha adds. The components are exported too, for an app that lays the explorer out itself.

#API Reference

#Primitives

  • $uiSwagger - An API explorer page, reading the app's OpenAPI document.

#React Hooks

  • useSwaggerAccess - Answers SwaggerAccess for each operation, against the current user.