@sallbro/auto-api-doc v1.0.1

🚀 API DOC FOR FRAMEWORK EXPRESS, FASTIFY, AND KOA WITH SWAGGER UI

📌 Features

✅ Supports Express, Koa, and Fastify — Generate OpenAPI docs for any of these frameworks.
✅ Swagger UI Integration — Visualize API documentation interactively. ✅ Generates YAML & JSON OpenAPI Files — Saves openapi.yaml and openapi.json formats.
✅ Beta Feature: OpenAPI Files To Code Generation! 🚀

📖 Example Usage

Generate OpenAPI documentation for Express, Koa, or Fastify with one command! 🎯

Install Dependencies

npm install @sallbro/auto-api-doc

Generate Doc

const { generateOpenAPISpec, writeOpenAPIFiles } = require("@sallbro/auto-api-doc");

const openapiSpec = generateOpenAPISpec("express",app); // pass framework name and application route as a parameter
writeOpenAPIFiles(openapiSpec, "./docs"); // generate doc file - .yaml and .json

Setup swagger ui

const { setupSwaggerUI } = require("@sallbro/auto-api-doc");
setupSwaggerUI(app, openapiSpec); // generate swagger ui at /api-docs/swagger-ui

express example

const express = require("express");
const { generateOpenAPISpec, writeOpenAPIFiles, setupSwaggerUI } = require("@sallbro/auto-api-doc");
const app = express();

const openapiSpec = generateOpenAPISpec("express",app); // pass framework name and application route as a parameter
writeOpenAPIFiles(openapiSpec, "./docs"); // generate doc file - .yaml and .json
setupSwaggerUI(app, openapiSpec); // generate swagger ui at /api-docs/swagger-ui

fastify example

const fastify  = require("fastify");
const { generateOpenAPISpec, writeOpenAPIFiles, setupSwaggerUI } = require("@sallbro/auto-api-doc");
const app = fastify();

const openapiSpec = generateOpenAPISpec("express",app); // pass framework name and application route as a parameter
writeOpenAPIFiles(openapiSpec, "./docs"); // generate doc file - .yaml and .json
setupSwaggerUI(app, openapiSpec); // generate swagger ui at /api-docs/swagger-ui

koa example

const Koa = require("koa");
const Router = require("@koa/router");
const app = new Koa();
const router = new Router();
const { generateOpenAPISpec, writeOpenAPIFiles, setupSwaggerUI } = require("@sallbro/auto-api-doc");

const openapiSpec = generateOpenAPISpec("express",router); // pass framework name and application route as a parameter
writeOpenAPIFiles(openapiSpec, "./docs"); // generate doc file - .yaml and .json
setupSwaggerUI(router, openapiSpec); // generate swagger ui at /api-docs/swagger-ui

🚀 Beta Feature

Generate Code from doc.yaml or doc.json file for Express, Koa, or Fastify with one command! 🎯

Generate Code

const { generateCodeFromOpenAPI } = require("@sallbro/auto-api-doc");

generateCodeFromOpenAPI("./docs/openapi.yaml", "./output","express");