Más información sobre el diseño de API personalizadas

En Oracle Mobile Hub, puede crear API de REST personalizadas que puedan utilizar las aplicaciones móviles.

Si es desarrollador de aplicaciones móviles, utilice el diseñador de API para esbozar y probar los puntos finales que defina y, a continuación, hacer que un desarrollador de servicios complete los detalles de la API (agregar tipos de recursos o rasgos, proporcionar un esquema y definir el acceso a la API y sus puntos finales) e implantarla en JavaScript. Si es desarrollador de servicios, utilice el diseñador de API para configurar explícitamente una API completa que puede probar con datos ficticios. También puede generar API personalizadas a partir de conectores de REST o Fusion Applications sin escribir ningún código.

A diferencia de las API de la plataforma Oracle Mobile Hub, que proporcionan un conjunto básico de servicios conocidos, las API personalizadas le permiten utilizar Node.js para codificar cualquier servicio que necesite la aplicación móvil, publicado a través de una interfaz REST. Puede transmitir datos mediante un conector de Oracle Mobile Hub a un servicio de backend, que transforma datos complejos en cargas útiles para dispositivos móviles. Al utilizar API personalizadas para crear un catálogo de servicios reutilizables, puede ahorrar mucho tiempo que, de lo contrario, podría dedicarse periódicamente a volver a crear y mantener los detalles de implantación en sus aplicaciones móviles.

Acerca del proceso de diseño de API

El diseñador de API le guiará a través del proceso de creación de una API personalizada.

Puede crear rápidamente una versión de borrador de la API en solo unos pasos:

Agregue los conceptos básicos (nombre de la API, tipo de medio de mensaje y una breve descripción).
Defina un punto final definiendo un recurso y al menos un método para él.
Definición de la seguridad de acceso.
Pruebe el punto final después de definir al menos un recurso.

Puede crear datos ficticios para probar y validar rápidamente un punto final incluso cuando no haya terminado de configurar la API por completo. Al definir el cuerpo del mensaje, puede proporcionar valores de marcador de posición para verificar que se están enviando o devolviendo los datos correctos.

Para completar completamente la API, utilice el diseñador de API para ayudarle a agregar los componentes esenciales para una API sólida:

Proporcione los metadatos de API (es decir, los atributos básicos de la API, que son el nombre mostrado de la API, el nombre de la API y la descripción corta) o, si ya tiene un documento RAML que contiene la configuración de la API, puede cargarlo en el diseñador de API. Toda la información (metadatos, recursos, métodos y el esquema del cuerpo del mensaje) se extrae del documento RAML y se carga en el diseñador de API, lo que permite pasar rápidamente a probar los puntos finales o editar la configuración de la API.
Agregue uno o más recursos raíz y anidados.
Agregue métodos para actuar sobre los recursos.
Cree un esquema para describir el cuerpo de los datos.
Pruebe los puntos finales durante el tiempo de diseño con datos de muestra y realice los cambios necesarios.
Permita el acceso anónimo a la API o especifique qué roles pueden acceder a ella.
Agregar documentación para su API personalizada

Más adelante, a medida que cree más API, puede que encuentre que está definiendo repetidamente los mismos métodos y utilizando los mismos parámetros, etc. Puede reducir la redundancia creando tipos de recursos y rasgos. Si la API sigue en estado de borrador, puede volver a la configuración y agregar los tipos de recursos y rasgos que ha definido.

Acerca de la generación de API personalizadas para conectores

Oracle Mobile Hub puede generar código personalizado a partir de conectores para conectarse a servicios externos. Como desarrollador de servicios, puede seleccionar un conector de Oracle Fusion Applications o un conector de REST creado con un descriptor válido, generar la API personalizada y utilizar la API generada para facilitar la llamada a estos servicios desde las implantaciones de las API personalizadas o directamente desde una aplicación móvil.

Un conector es una forma de permitir que un backend móvil se comunique con un servicio externo como un sistema empresarial o API de terceros, lo que a su vez permite que una aplicación móvil interactúe con las funciones de ese servicio. Una API de conector es una configuración para comunicarse con un servicio externo específico para enviar y recibir datos.

Como desarrollador de servicios, puede generar una API personalizada que muestre los métodos de una API de conector y proporcione una implantación por defecto sin escribir código.

La API personalizada se genera con un punto final para cada recurso de la API de conector y se abre en el diseñador de API para que pueda seguir especificando detalles de la API, como roles. La implantación por defecto, que pasa por todas las solicitudes procedentes de la API personalizada generada a la API del conector de destino, también se genera y asigna a la API generada. Tan pronto como haya asignado roles a la API si son necesarios para la seguridad en el conector, puede utilizar la implantación para probar la API. Puede descargar y modificar la implantación y, a continuación, cargarla.

Ser capaz de crear una API personalizada para un conector significa que es mucho más fácil crear un prototipo que se utiliza para probar un conector. A medida que encuentre las cosas que desea cambiar, puede realizar rápidamente un cambio en el conector y generar una nueva API e implantación personalizadas. Cuando esté satisfecho, puede generar una versión final de la API y la implantación personalizadas.

Desarrolle un conector REST o un conector de Oracle Fusion Cloud Applications definido mediante un descriptor.
Genere la API personalizada desde el conector. Se abre en el diseñador de API, donde puede definir uno o más roles o especificar la autenticación que necesita la API.
Puede llamar inmediatamente a la API generada desde el dispositivo móvil. La implantación por defecto transfiere todas las solicitudes procedentes de la API generada a la API del conector de destino.
Probablemente desee descargar la implantación y modificarla para dar forma a los datos devueltos.
Puede que desee volver a visitar el conector y realizar cambios en los recursos o el descriptor del conector. Si lo hace, debe generar una nueva API e implantación personalizadas. Si realiza cambios en la API personalizada generada, estos cambios no se reflejan en el conector. Debe realizar los cambios adecuados en el conector y, a continuación, generar la API personalizada y la implantación de nuevo.

Solo puede generar una API personalizada para un conector de REST u Oracle Fusion Cloud Applications, que se define mediante un descriptor. No puede generar una API personalizada para otro tipo de conector o cuando el conector de REST u Oracle Fusion Cloud Applications no tiene un descriptor.

Si desea enviar datos de formularios de varias partes o utilizar el objeto de opciones http, puede que tenga que sustituir el método callConnector en la implantación por su propio código.

API de conector REST

Puede crear API de conector para conectarse a servicios REST externos. A continuación, puede llamar a estas API de conector desde las implantaciones de sus API personalizadas.

Funcionamiento de las API del conector REST

Una API de conector REST es una API intermediaria para llamar a puntos finales REST en sistemas empresariales o API de terceros. La API de conector adopta la forma de una configuración que proporciona a las aplicaciones una forma estándar de conectarse a estos servicios REST y aprovechar la seguridad, el diagnóstico y otras funciones proporcionadas por Oracle Mobile Hub.

El conector comunica y transfiere información entre el cliente y el servidor mediante el protocolo HTTPS. La información transferida puede tener el formato XML o JSON (pero solo en JSON para servicios basados en descriptores de Swagger).

El asistente de API de conector de REST le guiará a través de la creación de API de conector de REST, desde la especificación de un servicio remoto y la definición de políticas de seguridad hasta la prueba de sus puntos finales.

¿Por qué utilizar conectores en lugar de llamadas directas a recursos externos?

El uso de una API de conector REST le proporciona las siguientes ventajas a la hora de realizar llamadas directas desde el código de su aplicación a recursos externos:

Permite una conexión declarativa simplificada y la configuración de políticas.
Con un descriptor de Swagger, determina los recursos disponibles y crea puntos finales.
Proporciona información de diagnóstico extensa porque está estrechamente integrada con el marco de diagnóstico de Oracle Mobile Hub. Se registran las llamadas REST salientes realizadas a través de las API de conector, lo que ayuda en gran medida a la depuración.
Permite realizar un seguimiento y análisis del uso de la API remota.
Permite definir la interacción con el servicio en tiempo de diseño al probar la validez de los puntos finales para que los términos de esa interacción no dependan de la entrada del usuario en tiempo de ejecución. Esto protege tanto el sistema final como el backend móvil de posibles daños.
Proporciona un enfoque de diseño consistente entre varios tipos de conectores para interactuar con servicios externos.
Con cualquier cambio en la interfaz de un servicio, puede gestionar las actualizaciones, las pruebas y la migración necesarias en un solo lugar.