Este addon técnico extiende base_rest para añadir el soporte del mecanismo de autenticación auth_api_key a la documentación openapi generada.
Traducción automática al español (DeepSeek) de la descripción original de OCA, que está en inglés.
auto_awesome Qué hace este módulo
Generado por IA a partir del código · Odoo 18.0Añade información de seguridad de la clave API a la documentación OpenAPI generada automáticamente de los servicios REST, para que los desarrolladores vean que se requiere una cabecera API-KEY.
Este módulo es un puente técnico entre el framework REST y el módulo de autenticación por API key. No añade menús, botones ni pantallas para los usuarios habituales; su efecto es visible en la documentación OpenAPI que Odoo genera para los servicios REST.
Cuando un servicio REST construye su especificación de API, este módulo registra un plugin de documentación adicional. Ese plugin declara un esquema de seguridad llamado api_key que espera una API key enviada en una cabecera HTTP llamada API-KEY.
Para cada operación documentada, el plugin comprueba la configuración de autenticación de la ruta. Si la ruta usa api_key, o usa public_or_default mientras que el valor por defecto del servicio es api_key, la operación se marca como que requiere el esquema de seguridad api_key. Las demás rutas se dejan sin cambios.
El módulo extiende el componente base.rest.service y sobrescribe su método _get_api_spec para adjuntar el plugin. Depende de base_rest y auth_api_key, y se instala automáticamente cuando ambos están presentes. También requiere la librería apispec de Python.
En resumen, mantiene precisa la documentación de API generada para los servicios protegidos por API keys, lo que ayuda a los integradores a entender cómo autenticar sus llamadas.
Depende de
Modelos y campos (1)
- base.rest.service · amplía un modelo existente
Texto generado por IA (DeepSeek) al leer el código de la versión 18.0 en GitHub; puede contener errores, así que verifícalo en el código antes de decidir. Ver el código en GitHub
Disponibilidad por versión
Revisado: 2026-11-03Estado de confirmación: 4 confirmadas, 5 sin información de 9 versiones.
Fuentes · Odoo 16.0
Confirmado el 2026-11-03 en la rama 16.0 de OCA/rest-framework.
terminal Instalación y uso
Sin información verificadaLas instrucciones de instalación, el paquete de distribución, las dependencias y los pasos de configuración no se muestran porque todavía no se han verificado en la documentación del módulo para ninguna versión.
Datos importados de GitHub: esta ficha refleja la última revisión del catálogo, no una consulta en directo. Verifica siempre en la documentación del módulo y en staging antes de instalar en producción.