Create from Connector

Puede crear recursos desde conectores (connectors) que están habilitados en la Plataforma. Lea más sobre conectores y cómo habilitarlos.

Para crear un recurso a partir de un conector:

  1. En el menú API Catalog, vaya a la pantalla de edición de recursos de la API;

  2. Haga clic en el botón Create from Connector;

  3. Seleccione el conector deseado de la lista o búsquelo por nombre;

  4. Haga clic en la opción Create using instruction;

  5. Agregue el nombre del recurso (obligatorio) y una descripción (opcional).

Después de crear el recurso, será redirigido a la pantalla de edición, donde podrá agregar operaciones al recurso:

  1. Haga clic en Add New Operation;

  2. Inserte el método HTTP y la ruta (path). Opcionalmente, agregue una descripción;

  3. En el campo Instruction, use las palabras reservadas del conector. Este campo tiene autocompletar para ayudarle a crear la instrucción.

resourceFromConnector addOperation
Figure 1. Operación POST para un conector AWS Lambda

En el ejemplo anterior, estamos creando una operación POST para un conector de AWS Lambda, que responderá en el recurso /aws. El campo Instruction incluye la información esperada por la función.

El recurso guardado en la API tendrá una etiqueta del conector vinculada a él:

resourceFromConnector resourceLabel

La API debe ser desplegada en el mismo entorno donde el conector está configurado. Haga el despliegue en la sección Environments de la pantalla de Overview de la API.

resourceFromConnector environments
El campo Instruction interpreta la sintaxis nativa del protocolo al que el conector permite acceso. Por ejemplo, para conectores de bases de datos, un conector Oracle no permite ; al final de la instrucción, mientras que un conector MySQL sí lo permite..

Ejemplo con conector SQL

Crear una operación con el conector SQL para devolver una consulta en una tabla de base de datos:

  1. Siga las instrucciones anteriores para crear el recurso;

  2. Haga clic en Add New Operation;

  3. Seleccione el método GET;

  4. En el campo Path, ingrese: /users;

  5. En el campo Instruction, ingrese:

select * from users
$body.syntaxsql

El resultado será un JSON con los datos de la consulta en la tabla users siguiendo la instrucción proporcionada.

Puede utilizar parámetros de header, path, query o body en la instrucción para el conector. Use las siguientes variables:

  • $headerParam.NOME_HEADER

  • $queryParam.NOME_QUERY

  • $pathParam.NOME_PATH

  • $body.NOME_ATRIBUTO

Consulte la subsección sobre variables de los conectores para más detalles sobre la sintaxis de las variables.

Después de guardar la API, podrá realizar solicitudes al recurso configurado.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]