Addon de demostración para ilustrar cómo desarrollar servicios REST autodocumentados gracias al addon base_rest.
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 16.0Este es un módulo de demostración que expone endpoints de ejemplo de la API REST para partners y un servicio ping, mostrando cómo construir servicios web autodocumentados con el framework Base REST.
Este módulo no añade ninguna pantalla ni menú a la interfaz de usuario de Odoo. En su lugar, publica un conjunto de endpoints de servicios web de ejemplo bajo la ruta /base_rest_demo_api/, divididos en áreas públicas, privadas, de nueva API y JWT.
- Los endpoints públicos (no requieren inicio de sesión) incluyen un servicio ping que devuelve mensajes para llamadas get, search, create, update y delete, y servicios de búsqueda de partners que devuelven información del partner como nombre, dirección, teléfono, país y estado.
- Los endpoints privados requieren un usuario autenticado y permiten leer, buscar, crear, actualizar y archivar partners a través del modelo
res.partner. Un servicio independiente devuelve la imagen de un partner en tamaño small, medium o large. - Servicios de demostración adicionales muestran las mismas búsquedas de partners construidas con los estilos de API más recientes y con modelos pydantic, además de un servicio que lanza deliberadamente diferentes excepciones de Odoo (user error, validation error, access error, registro no encontrado, sesión expirada y otras) para que los desarrolladores puedan ver cómo se traducen los errores en respuestas HTTP.
- Un servicio de error reintentable simula un conflicto de concurrencia en la base de datos e informa cuántos reintentos fueron necesarios.
El módulo afecta principalmente a res.partner y utiliza modelos de datos como partner.info, partner.short.info, partner.search.param, country.info y state.info para describir las cargas útiles de solicitud y respuesta. Está pensado como un ejemplo técnico para desarrolladores, no como una funcionalidad para el usuario final.
Modelos y campos (12)
- state.info · modelo nuevoid, name
- country.info · modelo nuevoid, name
- partner.info · modelo nuevocity, phone, street, street2, zip_code, is_company
- ping.service · modelo nuevo
- partner.service · modelo nuevo
- ping.jwt.service · modelo nuevo
- exception.service · modelo nuevo
- partner.short.info · modelo nuevoid, name
- partner.search.param · modelo nuevoid, name
- partner_image.service · modelo nuevo
- partner.new_api.service · modelo nuevo
- partner.pydantic.service · modelo nuevo
Texto generado por IA (DeepSeek) al leer el código de la versión 16.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: 5 confirmadas, 4 sin información de 9 versiones.
Fuentes · Odoo 15.0
Confirmado el 2026-11-03 en la rama 15.0 de OCA/rest-framework.
terminal Instalación y uso
Documentación de OCA · Odoo 16.0Este módulo proporciona servicios REST de ejemplo basados en base_rest. La documentación de los servicios proporcionados está disponible en la URL /api-docs. Este frontend basado en Swagger se genera a partir de los servicios web implementados.
Traducción automática al español (DeepSeek) de la documentación original de OCA; los comandos y el código no se traducen. Sin información verificada en OCA: Instalación, Configuración.
Las 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.