DataWorks:Registrar un servicio de API externo

Registrar una API

Si no cuenta con una API, cree una primero. Para obtener más información, consulte Create an API from a data source (API Gateway).

1. En la página Service Development, haga clic en el icono y seleccione Create API > Register API.

   También puede abrir el proceso de negocio correspondiente, hacer clic con el botón derecho en API y elegir Create API > Register API.

2. En el cuadro de diálogo Register API, configure los parámetros.

   Parámetro	Descripción
   Location	Directorio where se almacena la API. Importante Se recomienda seleccionar primero la carpeta de destino. Si no hay ninguna carpeta disponible, create a business process primero.
   API Name	Nombre único de la API dentro del grupo de API Gateway y el espacio de trabajo.
   APIPath	Ruta de acceso de la API; por ejemplo, /user.
   Protocol	Protocolos compatibles: HTTP y HTTPS. Para invocar la API mediante HTTPS, debe publicarla en API Gateway, vincular un nombre de dominio dedicado en la consola de API Gateway y cargar un certificado SSL. Para obtener más información, consulte Enable HTTPS.
   Request Method	Métodos compatibles: GET, POST, PUT y DELETE.
   Response Type	Tipos compatibles: JSON y XML.
   Visible Scope	Opciones disponibles: Work space y Private. Work space: La API es visible para todos los miembros del espacio de trabajo actual. Private: La API solo es visible para su propietario. Las APIs privadas no admiten autorización. Nota Si establece el alcance de visibilidad como privado, solo usted podrá ver la API en el árbol de directorios; los demás miembros del espacio de trabajo no tendrán acceso.
   Tag	Seleccione una etiqueta de la lista Tag.
   Description	Descripción de la API (máximo 2,000 caracteres).

Configurar la API

1. Haga doble clic en la API registrada para abrir su página de configuración. En la sección Define Backend Service, configure los siguientes parámetros.

   Parámetro	Descripción
   Host	Host del servicio de backend. El valor debe comenzar con http:// o https:// y no debe contener una ruta de acceso. Nota Por ejemplo, si la URL de su servicio es http://xxx-cn-xxx.alicloudapi.com/user/info, establezca el host del servicio de backend en http://xxx-cn-xxx.alicloudapi.com. Configure este parámetro según la URL real de su servicio.
   Path	Ruta de acceso del servicio de backend. Puede incluir parámetros de ruta entre corchetes ([]), como /user/[userid]. Al configurar parámetros en la ruta, el sistema los agrega automáticamente a la lista de parámetros de solicitud y define su posición como PATH. Nota Por ejemplo, si la URL de su servicio es http://xxx-cn-xxx.alicloudapi.com/user/info, establezca la ruta del servicio de backend en /user/info. Configure este parámetro según la URL real de su servicio.
   Back-end Service Timeout	Tiempo de espera del servicio de backend.

2. En la sección Define Request Parameters, configure los siguientes parámetros.

   La tabla Request Parameters incluye columnas como Parameter Name, Parameter Position, Parameter Type, Required, Example Value, Default Value y Description. La tabla Constant Parameters incluye Parameter Name, Parameter Position, Parameter Type, Default Value y Description.

   Parámetro	Descripción
   Request Parameters	Haga clic en Add para configurar los parámetros de solicitud de la API. La opción Parameter Position puede ser QUERY, HEAD, PATH o Body. Las posiciones disponibles dependen del método de solicitud seleccionado. Elija la posición adecuada según sus necesidades.
   Constant Parameters	Los parámetros constantes tienen valores fijos y permanecen ocultos para quienes invocan la API. El servicio de backend siempre recibe estos parámetros con los valores configurados.
   Request body definition	Esta sección aparece solo cuando el método de solicitud es POST o PUT. Puede proporcionar un cuerpo de solicitud de ejemplo en formato JSON o XML para mostrar a los usuarios cómo estructurar la solicitud.

3. En la sección Define Response Content, proporcione un Correct Response Example y un Error Response Example. Estos ejemplos ayudan a los usuarios a comprender el formato de respuesta y a escribir el código de análisis sintáctico.

4. En la sección Error Code Definition, defina el Error Code, el Error message y la Solution para posibles errores. Esto facilita que los usuarios diagnostiquen y resuelvan problemas de forma independiente.

5. Haga clic en el icono de la barra de herramientas superior para guardar la API.