Construir y configurar una herramienta

Comience con la documentación oficial de la API para el servicio empresarial y una tarea que su cuenta pueda realizar. Una herramienta limitada y bien descrita es más fácil de probar que una herramienta genérica que acepte una URL y un método arbitrarios.

Definir la solicitud#

Asigne a la herramienta un nombre estable y una descripción que explique su propósito, límites importantes y si cambia datos. Seleccione el método HTTP documentado y el punto final. Utilice marcadores de posición sólo para los elementos de ruta variables que la operación realmente permite.

Para una búsqueda de registros ficticios, la ruta puede contener un identificador de registro. El nombre de host y la región de la cuenta deben seguir siendo parte de la conexión configurada en lugar de una entrada de modelo abierta.

Definir y asignar entradas#

Utilice el esquema de entrada para describir cada campo, su tipo, estado requerido y valores válidos. Un pequeño esquema para una búsqueda ficticia es:

{
  "type": "object",
  "properties": {
    "record_id": {
      "type": "string",
      "description": "The verified identifier of the record to read"
    }
  },
  "required": ["record_id"],
  "additionalProperties": false
}

Asigne argumentos a la ruta documentada, a la consulta o a los campos del cuerpo. Compruebe que los campos obligatorios que faltan y los argumentos adicionales inesperados fallen claramente. Mantenga la autenticación en la conexión del servidor compatible, no en un mensaje, un esquema de ejemplo o un encabezado de herramienta codificado.

Dar forma a la salida#

El mapeo o la transformación de respuestas pueden devolver los campos que el flujo de trabajo necesita en lugar de una respuesta de servicio completa. Verifique la salida transformada con el resultado de la prueba original. No elimine el identificador del registro, la información de paginación ni los detalles del error necesarios para saber si el resultado está completo.

Revisar la configuración operativa#

La configuración de la herramienta admite configuraciones de tiempo de espera, almacenamiento en caché y reintento. Utilice el almacenamiento en caché sólo cuando los datos obsoletos sean aceptables; una lectura en caché no es adecuada como prueba final de que se acaba de completar una escritura. Reintentar una escritura no idempotente puede crear duplicados, así que elija el comportamiento de reintento entre las garantías documentadas de la API.

Prueba el camino real#

Verifique la entrada correcta, la entrada no válida, los resultados vacíos, la falla de permiso y una llamada exitosa limitada. Los diagnósticos de prueba pueden contener información de solicitud confidencial; inspecciónelos solo a través de la ruta del administrador aprobado y elimínelos antes de compartirlos. Ver prueba antes de que un cliente utilice la herramienta.