Agrega la sección login
a tu apidoc.json
:
{
"name": "Mi API",
"version": "1.0.0",
"login": {
"active": true,
"admited": [
{
"email": "admin@miempresa.com",
"password": "mi_password_seguro"
}
]
}
}
# Instalar APIDoc 4.0
npm install -g @hrefcl/apidoc
# Generar con autenticación
apidoc -i src/ -o docs/
# Servir documentación
npx serve docs/ -p 8080
# Abrir en navegador
open http://localhost:8080
¡Listo! Tu documentación ahora requiere login para acceder.
{
"login": {
"active": true,
"admited": [
{"email": "user1@example.com", "password": "pass123"},
{"email": "user2@example.com", "password": "pass456"}
]
}
}
{
"login": {
"active": true,
"urlAuth": "https://api.miempresa.com/auth/login",
"value_form": {
"email": "email",
"password": "password"
},
"response_success": 200,
"response_error": 401
}
}
{
"login": {
"active": true,
"admited": [
{"email": "admin@local.com", "password": "local123"}
],
"urlAuth": "https://api.miempresa.com/auth/login",
"value_form": {
"email": "email",
"password": "password"
},
"response_success": 200,
"response_error": 401
}
}
Usa las credenciales de ejemplo:
odin@href.cl
6789123450
Estas funcionan tanto para autenticación local como remota.
Ver AUTHENTICATION.md para:
Solución: Verificar en consola del navegador:
console.log('AuthManager:', !!window.AuthManager);
console.log('Config:', window.LOGIN_CONFIG);
Solución: Usar script de validación:
cd docs/
node test-credentials.js
Solución: Regenerar documentación:
apidoc -i src/ -o docs/ --debug
¡Tu API Documentation está protegida y lista! 🎉