Crear Oracle REST Data Services (ORDS) en KeepTool 16

Actualizado en octubre de 2025

---

Introducción

¡Bienvenido de nuevo al blog de KeepTool!

En este artículo, mostraremos cómo KeepTool 16 facilita el trabajo con Oracle REST Data Services (ORDS), un potente marco que expone su base de datos Oracle como servicios web RESTful.

Con ORDS, puede acceder a los objetos de la base de datos mediante solicitudes HTTP(S) estándar (GET, POST, PUT, DELETE) y devolver los resultados como JSON. Esto permite una integración ligera entre las bases de datos Oracle y las aplicaciones modernas escritas en JavaScript, Python o cualquier otro lenguaje que pueda consumir API REST.

ORDS es la base de muchas tecnologías de Oracle, entre las que se incluyen:

• Oracle APEX, donde proporciona acceso REST para aplicaciones y consultas SQL habilitadas para REST

• API personalizadas, que permiten a los desarrolladores exponer datos y lógica desde sus propios esquemas

Al combinar KeepTool Hora con ORDS, puede diseñar, probar y gestionar servicios REST directamente desde una interfaz gráfica, sin necesidad de codificación PL/SQL manual.

---

Comprensión de la arquitectura ORDS y la estructura de URL

Cada punto final de ORDS corresponde a un recurso específico de su base de datos y sigue una estructura de URL predecible:

Analicemos los componentes:

• hostname:port: el host y el puerto donde se ejecuta ORDS (por ejemplo, localhost:8080).

• ords: la ruta de contexto de la aplicación web.

• <pldb>: el nombre de la base de datos conectable (PDB).

• <schema>: el esquema de la base de datos que se expone.

• módulo: agrupación lógica de plantillas y controladores relacionados (como un módulo API).

• plantilla — Define el patrón URI para un recurso (por ejemplo /employees/).

• :id — Un parámetro URI que identifica un registro específico.

Cada plantilla puede tener uno o más controladores, que definen lo que sucede cuando un cliente realiza una solicitud GET, POST, PUT o DELETE en ese punto final.

---

Instalación y configuración de ORDS

Antes de utilizar KeepTool para gestionar objetos ORDS, es necesario instalar y configurar ORDS en su instancia de Oracle.

1. Descargue ORDS desde https://download.oracle.com/otn_software/java/ords/ords-latest.zip .

2. Dentro de la carpeta de instalación, localice elparamsdirectorio , que contiene ords_params.properties, que controla los valores de configuración, como la conexión a la base de datos y la ruta de contexto.

3. ORDS se puede implementar en varios modos:

   • Modo independiente (ideal para pruebas y desarrollo)

   • Apache Tomcat

   • Oracle WebLogic Server

4. Este tutorial utiliza el modo independiente, que se ejecuta directamente desde la línea de comandos.

5. Durante la primera ejecución, ORDS solicitará:

   • Una conexión a la base de datos (normalmente su base de datos conectable o base de datos contenedora)

   • Un usuario administrativo con privilegios, a menudo PDBADMIN

6. ORDS crea automáticamente dos esquemas internos:

   • ORDS_METADATA – almacena definiciones y metadatos de configuración

   • ORDS_PUBLIC_USER – el esquema utilizado para las conexiones web

Estos esquemas son la base sobre la que KeepTool construye su interfaz de gestión ORDS.

---

Iniciar el servidor ORDS (modo independiente en Windows)

Después de la instalación, asegúrese de que la ORDSbin la carpeta está incluida en su sistema PATH.

A continuación, puede iniciar el servidor ejecutando el siguiente comando:

ORDS abrirá un servidor web ligero que escucha las solicitudes HTTP y HTTPS. Ahora
puede acceder a él en un navegador o a través de KeepTool.

---

Habilitar ORDS para un esquema en KeepTool

En Hora de KeepTool, la funcionalidad ORDS se encuentra en el menú «Adicional».
La cuadrícula Esquema ORDS muestra qué esquemas están habilitados actualmente para REST.

Si tiene privilegios de administrador de ORDS, puede hacer clic con el botón derecho del ratón en esta cuadrícula y seleccionar:
👉 «Habilitar esquema»

Aparecerá un cuadro de diálogo que le permitirá:

• Elegir el esquema (por ejemplo HR)

• Definir un patrón de asignación de URI (por defecto: nombre del esquema en minúsculas, por ejemplo /hr/)

Una vez confirmado, Hora ejecuta las llamadas ORDS PL/SQL necesarias para habilitar REST para ese esquema.
Si está conectado como usuario normal, solo verá su propio esquema en la lista.

---

Creación de un módulo REST

Un módulo ORDS es un contenedor lógico para plantillas y controladores. Piense en él como un pequeño proyecto API; por ejemplo, podría crear un módulo llamado /hr_demo/.

Para crear uno en KeepTool:

1. Vaya a la pestaña Módulos.

2. Haga clic con el botón derecho del ratón → «Crear módulo».

3. Introduzca el nombre del módulo y la URI base.

4. Confirme los cambios.

El nuevo módulo aparecerá en la lista, junto con su ruta de contexto y su esquema.

---

Creación de una plantilla ORDS

Una plantilla define una ruta de recursos dentro de un módulo. Por ejemplo, puede crear una plantilla /emp para representar los datos de los empleados.

Pasos:

1. Vaya a la pestaña Plantillas.

2. Haga clic con el botón derecho del ratón → «Crear plantilla».

3. Asigne la nueva plantilla a un módulo existente (por ejemplo hr_demo).

4. Introduzca un patrón URI como emp.

5. Añada un comentario opcional para describir su finalidad.

La nueva plantilla aparecerá en la lista y Hora mostrará automáticamente ejemplos de URI HTTP y HTTPS que podrá utilizar más adelante para realizar pruebas.

---

Definición de un controlador (la lógica REST)

Cada plantilla necesita uno o varios controladores para definir cómo se procesan las solicitudes entrantes.

Para crear uno en Hora:

1. Abra la pestaña Controladores.

2. Haga clic con el botón derecho → «Crear controlador».

3. Seleccione la plantilla (por ejemplo /emp).

4. Elija el método HTTP (GET, POST, PUTo DELETE).

5. Elija el formato de entrada/salida (normalmente JSON).

6. En el editor SQL, escriba su consulta o lógica PL/SQL.

A continuación, defina los parámetros para :id y :sal mediante la cuadrícula de parámetros situada debajo del editor SQL:

• Haga clic con el botón derecho → «Definir parámetro»

• Añada nombres, tipos de datos y valores predeterminados si es necesario

Hora genera automáticamente URI de muestra para realizar pruebas, por ejemplo:

---

Prueba del servicio REST

Ahora es el momento de verificar que su nuevo servicio funciona.
Con el servidor ORDS en ejecución:

1. Copie uno de los URI generados desde Hora.

2. Péguelo en su navegador o en un cliente REST (como Postman).

3. La respuesta debería ser datos JSON de la EMPLOYEES tabla.

Puedes pasar fácilmente parámetros URL como ?id=123 o ?sal=10000 para filtrar los datos de forma dinámica.
Esto permite que su servicio REST solo entregue los registros relevantes, lo que facilita la integración de consultas de bases de datos en aplicaciones web o móviles.

Como puede ver, la respuesta JSON contiene un único objeto EMPLOYEE junto con varios campos de referencia HTTP de apoyo.
Alternativamente, puede filtrar los resultados por salario añadiendo un sal parámetro a la solicitud.
Por ejemplo, la consulta con ?sal=10000 devuelve todos los empleados cuyo salario supera los 10 000.

---

Ampliación de los servicios ORDS

Una vez que domine los conceptos básicos, puede ampliar su servicio ORDS mediante:

• Añadiendo POST, PUTy DELETE manejadores para la modificación de datos

• Devolver datos jerárquicos o matrices JSON

• Utilizar esquemas de autorización para controlar el acceso

• Integración de sus puntos finales en APEX u otras aplicaciones web

ORDS es una capa web con todas las funciones para Oracle, y KeepTool proporciona una interfaz gráfica de usuario intuitiva para explorarla y gestionarla sin necesidad de escribir manualmente paquetes PL/SQL complejos.

---

Resumen

Con KeepTool 16 y Oracle REST Data Services, puede:

1. Habilitar ORDS en un esquema

2. Crear módulos, plantillas y controladores REST

3. Definir puntos finales REST basados en SQL en cuestión de minutos

4. Probar y previsualizar sus API REST directamente en Hora

Este flujo de trabajo optimizado permite a los desarrolladores, administradores de bases de datos y analistas crear servicios REST modernos y compatibles con los estándares a partir de los datos Oracle existentes, de forma rápida y visual.

---