Alepha Server Swagger

Generates OpenAPI documentation and a Swagger UI for APIs.

Installation

This package is part of the Alepha framework and can be installed via the all-in-one package:

npm install alepha

Module

Plugin for Alepha Server that provides Swagger documentation capabilities. It generates OpenAPI v3 documentation for the server's endpoints ($action). It also provides a Swagger UI for interactive API documentation.

This module can be imported and used as follows:

import { Alepha, run } from "alepha";
import { AlephaServerSwagger } from "alepha/server/swagger";

const alepha = Alepha.create()
  .with(AlephaServerSwagger);

run(alepha);

API Reference

Descriptors

Descriptors are functions that define and configure various aspects of your application. They follow the convention of starting with $ and return configured descriptor instances.

For more details, see the Descriptors documentation.

$swagger()

Create a new OpenAPI.