📚 Documentación APIDoc 4.0

Bienvenido a la documentación completa de APIDoc 4.0. Esta guía te permitirá aprovechar al máximo todas las funcionalidades de la herramienta.

🚀 Inicio Rápido

1. Configuración básica - Configura tu primer proyecto
2. Parámetros APIDoc - Aprende la sintaxis básica
3. Ejemplos prácticos - Ve ejemplos funcionando

🏗️ Configuración y Personalización

• 📋 Configuración de apidoc.json - Configuración completa del proyecto
• 🎨 Iconos y Personalización - Font Awesome, logos, temas
• 📄 Markdown Personalizado - Contenido markdown por secciones
• 🎨 Temas de Sintaxis - 160+ temas de resaltado de código

🔧 Funcionalidades Core

• 📖 Parámetros APIDoc - Referencia completa de @api, @apiParam, etc.
• 📝 Ejemplos y Plantillas - Ejemplos prácticos de uso
• 🔄 Versionado y Herencia - Gestión de versiones y reutilización
• 💻 Uso Programático - Integración en Node.js

🌐 Protocolos y Formatos Modernos

• 🔌 OpenAPI 3.0 - Soporte nativo y exportación
• 📡 Protocolo MQTT - Documentación IoT completa
• 📊 Esquemas TypeScript - Integración @apiSchema

🔐 Seguridad y Autenticación

• 🛡️ Sistema de Autenticación - Protección de documentación
• 🚀 Guía Rápida Auth - Setup en 3 pasos
• 👨‍💻 Referencia de Desarrollador - API técnica de autenticación

🛠️ Desarrollo y Deploy

• 🔨 Desarrollo Local - Setup del entorno de desarrollo
• 🐳 Docker y Containers - Uso con contenedores
• 🔧 Herramientas y Plugins - Integración con Grunt, Webpack, etc.

💡 Casos de Uso Comunes

Para APIs REST

1. Configura apidoc.json
2. Añade parámetros @api a tus endpoints
3. Personaliza con iconos y temas

Para APIs MQTT

1. Revisa la guía MQTT
2. Configura parámetros MQTT
3. Añade ejemplos de mensajes MQTT

Para Proyectos TypeScript

1. Configura esquemas TypeScript
2. Usa validación automática
3. Integra con OpenAPI

Para Documentación Protegida

1. Sigue la guía rápida
2. Configura autenticación
3. Revisa la API técnica

🎯 Características Destacadas v4.0

• ✅ Custom Markdown: Contenido personalizado por secciones
• ✅ MQTT Protocol: Soporte completo para IoT
• ✅ OpenAPI 3.0: Integración nativa
• ✅ TypeScript: Esquemas automáticos
• ✅ Authentication: Sistema dual de protección
• ✅ 160+ Themes: Temas de resaltado de código
• ✅ Docker: Contenedores listos para producción

🤝 Contribuir

¿Quieres contribuir? Ve la guía de desarrollo para configurar tu entorno local.

APIDoc 4.0 - Generación de documentación API moderna y poderosa. Hecho con ❤️ por la comunidad APIDoc.