asyncapi-ui-express

Serves documentation generated by @asyncapi/cli via Express. Swagger-ui-express but for AsyncAPI.

This library validates the documentation directory at setup and returns an static file middleware for Express.

Why Use This?

AsyncAPI documentation generation tools output static HTML and assets to a directory.
This middleware makes it easy to serve those files via an Express middleware with minimal setup.

Installation

npm install asyncapi-ui-express

Usage

1. Generate documentation with @asyncapi/cli:

asyncapi generate from-file ./asyncapi.yaml --output ./output --template @asyncapi/html-template

2. Serve generated directory with Express and asyncapi-ui-express:

const express = require("express");
const { serve } = require("asyncapi-ui-express");

const app = express();

app.use("/docs", serve("./output")); // Docs

app.use("/api", apiRouter); // API

app.listen(8000, () => {
    console.log(
        "Server listening on port 8000. Docs available at http://localhost:8000/docs"
    );
});

Contributions

Contributions are welcome. See CONTRIBUTING.md.