APIDoc 4.0

RESTful web API & MQTT Protocol Documentation Generator - A modern TypeScript fork of the original apidoc project with active maintenance, modern tooling, and comprehensive MQTT support.

🚀 What's APIDoc?

APIDoc generates comprehensive documentation for RESTful APIs and MQTT protocols from source code comments. Compatible with C#, Go, Dart, Java, JavaScript, PHP, TypeScript, Python, Ruby and more.

Quick Example:

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */
Copy

🎯 Quick Start

# Global installation
npm install -g @hrefcl/apidoc

# Generate documentation
apidoc -i src/ -o docs/

# View documentation
open docs/index.html
Copy

📚 Complete Documentation

🛠️ Configuration & Customization

• 📋 Configuration - Complete apidoc.json project configuration
• 🎨 Icons & Customization - Font Awesome, logos, themes
• 📄 Custom Markdown - Custom content for sections
• 🌈 Syntax Themes - 160+ code highlighting themes

📋 Core Functionality

• 📖 APIDoc Parameters - Complete @api, @apiParam reference
• 💡 Examples & Templates - Practical usage examples
• 🔄 Versioning & Inheritance - Version management and reuse
• ⚙️ Programmatic Usage - Node.js integration

🌐 Modern Protocols & Formats

• 🔌 OpenAPI 3.0 - Native support and export
• 📡 MQTT Protocol - Complete IoT documentation
• 📊 TypeScript Schemas - @apiSchema integration

🔐 Security & Authentication

• 🛡️ Authentication System - Documentation protection
• 🚀 Quick Auth Setup - Setup in 3 steps
• 👨‍💻 Developer Reference - Technical authentication API

🛠️ Development & Deploy

• 🔨 Local Development - Development environment setup
• 🐳 Docker & Containers - Container usage and deployment
• 🔧 Build Tools - Integration with Grunt, Webpack, etc.

🌟 Key Features v4.0.5

📝 Custom Markdown Content

Add custom markdown content to any API group with rich formatting:

{
  "settings": {
    "Users": {
      "icon": "fa-user",
      "title": "User Management",
      "filename": "user.md"
    }
  }
}
Copy

📡 Complete MQTT Support

Document MQTT protocols with 16 specialized tags:

/**
 * @mqtt {publish} v1/sensors/{id}/data Publish Sensor Data
 * @mqttGroup IoT
 * @topic v1/sensors/{id}/data
 * @qos 1
 * @retain false
 */
Copy

🔐 Dual Authentication System

Protect your documentation with local and remote authentication:

{
  "login": {
    "active": true,
    "admited": [{"email": "admin@company.com", "password": "secure123"}],
    "urlAuth": "https://api.company.com/auth/login"
  }
}
Copy

🌐 Native OpenAPI 3.0

Write OpenAPI specifications directly in comments:

/**
 * @openapi
 * /api/users/{id}:
 *   get:
 *     summary: Get user by ID
 *     parameters:
 *       - name: id
 *         in: path
 *         required: true
 *         schema:
 *           type: integer
 */
Copy

📊 TypeScript Integration

Generate documentation from TypeScript interfaces:

/**
 * @api {get} /users/:id Get User
 * @apiSuccess {Object} user User data
 * @apiSchema {User} user
 * @apiSchemaFile ../types/user.ts
 */
Copy

🌍 Languages

• 🇺🇸 English (Primary): Documentation
• 🇪🇸 Español: Documentación

🔗 Links & Resources

• 📦 NPM Package
• 🏠 Official Website
• 🚀 Live Demo
• 💻 GitHub Repository

🤝 Support & Contributions

• 🐛 Report Issues
• 💬 Discussions
• 📖 Contribution Guide

📄 License

MIT License - see LICENSE file for details.

---

Made with ❤️ by the APIDoc community. Originally created by Peter Rottmann.