Generate Beautiful API Documentation
Automatically generate comprehensive, interactive API documentation for your Node.js applications. Simple setup, powerful features, and developer-friendly documentation that your team will love.
Powerful Features
Everything you need for professional Node.js documentation.
Multiple Export Formats
Export your API documentation in multiple formats including HTML, Markdown, JSON, and interactive web interfaces for seamless integration into any workflow.
RESTful API Support
Generate comprehensive and structured documentation for your RESTful APIs, covering all routes, methods, request parameters, responses, and status codes.
Framework Agnostic
Works out of the box with popular Node.js frameworks like Express.js, Fastify, Koa, NestJS, and others—no vendor lock-in.
Rich Documentation Output
Automatically generate detailed and developer-friendly documentation, complete with examples, parameter descriptions, response schemas, and error handling.
Easy Configuration
Simple setup with sensible defaults—configure input/output folders, titles, formats, and more with minimal effort to get started quickly.
Live Updates in Dev Mode
Enable watch mode to regenerate your documentation automatically whenever your code changes, improving feedback loops during development.
Get Started in Minutes
Follow these simple steps to generate beautiful API documentation for your Node.js project.
Install the Package
Add the node-api-document package to your project using npm or yarn.
npm install node-api-document💡 Make sure you have Node.js and npm installed on your system.
Setup Basic Configuration
Import and initialize the package within your Express.js project.
const express = require('express');
const createDoc = require('node-api-document');
const app = express();
const PORT = process.env.PORT || 3000;💡 This package works with Express.js applications.
Generate API Documentation
Define your API structure and generate rich documentation with ease.
const apiDoc = [
{
new_tag: "1",
color: "black",
title: "COMMON API",
icon: "list"
},
{
new_tag: "0",
color: "orange",
icon: "flag",
title: "1 : COMMON",
name: "Get Country List",
meth: "GET",
link: "http://localhost:3000/country_list",
mandatory: "",
optional: "",
is_header: "YES",
is_push: "NO",
header: "API-KEY",
notes: "This API is used to get the country list",
example: "",
status: "1. HTTP_OK [200] - status : success\n2. HTTP_OK [201] - status : error\n3. HTTP_NOT_FOUND [204]",
imp: ""
}
];
createDoc(app, 'token, api-key', apiDoc);
app.listen(PORT, () => {
console.log(`Server running on port ${PORT}`);
});💡 Your documentation will be available at /api-docs endpoint.
Ready to Generate Beautiful API Documentation?
Join thousands of developers using node-api-document.