{}
APIDocly
v1.0.0 now available

Beautiful API
Documentation
Made Simple

Generate stunning, dark-themed API documentation directly from your source code comments. Zero configuration needed.

$npm install -g apidocly
user.controller.js
/**
 * @api {get} /users/:id Get User Info
 * @apiName GetUser
 * @apiGroup Users
 * @apiVersion 1.0.0
 *
 * @apiParam {String} id User's unique ID
 *
 * @apiSuccess {Object} user User object
 * @apiSuccess {String} user.name Full name
 * @apiSuccess {String} user.email Email
 *
 * @apiError {404} NotFound User not found
 */
async getUser(req, res) {
  // ...
}
Parsed Successfully
Features

Everything you need for
perfect documentation

APIDocly provides all the tools you need to create beautiful, comprehensive API documentation.

Dark UI Design

Beautiful dark-themed documentation that's easy on the eyes during late-night coding sessions.

Version Comparison

Track API changes across versions. See added, removed, and modified endpoints at a glance.

Password Protection

Secure your API docs with AES-256-GCM encryption and password protection.

Powerful CLI

Simple command-line interface with flexible options for input, output, and configuration.

Rich Annotations

Support for 20+ annotation types including params, headers, responses, examples, and more.

Postman & Insomnia

Export your API to Postman Collection or Insomnia format for instant testing and collaboration.

AI-Ready Docs

Download OpenAPI JSON and let AI generate client code, TypeScript models, or full integrations.

Multi-Language

Parse documentation from JavaScript, TypeScript, Python, and PHP source files.

Environment Switching

Define multiple API environments (dev, staging, prod) and switch between them when testing endpoints.

Quick Start

Up and running
in seconds

Install globally with npm and generate documentation from your source files with a single command.

1

Install the CLI

npm install -g apidocly
2

Generate docs

apidocly -i ./src -o ./docs
3

Open and share

Open docs/index.html in your browser

CLI Options
# Basic usage
$ apidocly -i ./src -o ./docs

# With config file
$ apidocly -c apidocly.json

# Include private endpoints
$ apidocly -i ./src --private

# Single file export
$ apidocly -i ./src --single-file

# Verbose output
$ apidocly -i ./src --verbose
Documentation

Powerful
annotation system

Use familiar JSDoc-style annotations to document your API endpoints directly in your source code.

@api@apiName@apiGroup@apiVersion@apiDescription@apiParam@apiQuery@apiBody@apiHeader@apiSuccess@apiError@apiExample@apiSuccessExample@apiErrorExample@apiPermission@apiDeprecated@apiPrivate@apiDefine@apiUse
AI Prompt Example
User: Here's my API spec (openapi.json attached).
Generate a TypeScript client with Axios.

AI: Based on your OpenAPI specification,
here's a complete TypeScript client:

import axios from 'axios';

interface User {
  id: string;
  email: string;
  name: string;
}

export const getUser = async (
  id: string
): Promise<User> => {
  const { data } = await axios.get(
    `/users/${id}`
  );
  return data;
};
AI-Powered Workflow

OpenAPI JSON export for
AI-powered development

Every APIDocly documentation exports to OpenAPI 3.0 JSON format. Simply download and feed it to your favorite AI assistant to instantly:

  • Generate API Clients

    Get production-ready client code in TypeScript, Python, Go, or any language

  • Create Type Definitions

    Auto-generate TypeScript interfaces, Zod schemas, or Pydantic models

  • Build Full Integrations

    Let AI understand your entire API and build complete integration modules

Have feedback?

Found a bug or have a feature request? We'd love to hear from you.

feedback@apidocly.com