APIDoc v5 - RESTful web API Documentation Generator with Vue 3 and modern features
npm install @hrefcl/apidocRESTful web API & MQTT Protocol Documentation Generator - Generador moderno de documentación para APIs REST y protocolos MQTT con soporte completo para TypeScript, autenticación dual y contenido personalizado.
APIDoc genera documentación completa para APIs RESTful y protocolos MQTT desde comentarios en el código fuente. Compatible con C#, Go, Dart, Java, JavaScript, PHP, TypeScript, Python, Ruby y más.
``javascript`
/**
* @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.
*/
`bashInstalación global
npm install -g @hrefcl/apidoc
📚 Documentación Completa
$3
- 📋 Configuración - Configuración completa de apidoc.json
- 🎨 Iconos y Personalización - Font Awesome, logos, temas
- 📄 Markdown Personalizado - Contenido personalizado para secciones
- 📄 Ejemplos de Markdown - Ejemplos prácticos$3
- 📖 Parámetros APIDoc - Referencia completa de @api, @apiParam
- 💡 Ejemplos y Plantillas - Ejemplos de uso práctico
- 🔄 Versionado y Herencia - Gestión de versiones y reutilización
- ⚙️ Uso Programático - Integración con Node.js$3
- 🔌 OpenAPI 3.0 - Soporte nativo y exportación
- 📡 Protocolo MQTT - Documentación completa para IoT
- 📊 Schemas TypeScript - Integración con @apiSchema$3
- 🛡️ Sistema de Autenticación - Protección de documentación
- 🚀 Configuración Rápida Auth - Setup en 3 pasos
- 👨💻 Referencia Desarrollador - API técnica de autenticación$3
- 🔨 Desarrollo Local - Configuración de entorno de desarrollo
- 🐳 Docker y Contenedores - Uso y despliegue con contenedores
- 🔧 Herramientas de Build - Integración con Grunt, Webpack, etc.🌟 Características Principales v5.0.0
$3
Agrega contenido markdown personalizado a cualquier grupo de API con formato enriquecido:json
{
"settings": {
"Users": {
"icon": "fa-user",
"title": "Gestión de Usuarios",
"filename": "users.md"
}
}
}
`$3
Documenta protocolos MQTT con parsers especializados:javascript
/**
* @apiMqtt {publish} v1/sensors/{id}/data Publish Sensor Data
* @apiGroup IoT
* @apiMqttQos 1
* @apiMqttRetain false
* @apiMqttPayload {Object} data Sensor data payload
*/
`Características MQTT:
- ✅ 16+ parsers MQTT implementados (@apiMqtt, @apiMqttPayload, @apiMqttQos, etc.)
- ✅ Template específico para documentación MQTT
- ✅ CSS styling para métodos publish/subscribe
- ✅ Configuración de broker MQTT en apidoc.json para template
- ✅ CLI options: --mqtt-only, --fail-on-mqtt-schema-error
$3
Protege tu documentación con autenticación local y remota:Modo Local (Sin servidor):
json
{
"login": {
"active": true,
"encryptionKey": "tu-clave-base64",
"admited": [
{
"email": "admin@company.com",
"password": "secure123",
"name": "Admin User"
}
]
}
}
`Modo Servidor:
json
{
"login": {
"active": true,
"encryptionKeyFromServer": true,
"urlAuth": "https://api.company.com/auth/login",
"value_form": {
"email": "email",
"password": "password"
},
"response_success": 200,
"response_error": 401
}
}
`Características de Seguridad:
- ✅ Encriptación AES-256-GCM
- ✅ Ofuscación de claves de encriptación
- ✅ JWT con expiración de 24 horas
- ✅ Lista de usuarios encriptada
- ✅ No almacena claves en sessionStorage
$3
Escribe especificaciones OpenAPI directamente en comentarios:javascript
/**
* @openapi
* /api/users/{id}:
* get:
* summary: Get user by ID
* parameters:
* - name: id
* in: path
* required: true
* schema:
* type: integer
*/
`$3
Genera documentación desde interfaces TypeScript:typescript
/**
* @api {get} /users/:id Get User
* @apiSuccess {Object} user User data
* @apiSchema {User} user
* @apiSchemaFile ../types/user.ts
*/
``- 🇪🇸 Español (Principal): Documentación
- 📦 Paquete NPM
- 🏠 Sitio Web Oficial
- 💻 Repositorio GitHub
- 🐛 Reportar Issues
- 💬 Discusiones
- 📖 Guía de Contribución
MIT License - ver archivo LICENSE para detalles.
---