Los filtros de API permiten adjuntar lógica personalizada a una API sin modificar su implementación principal. Un prefiltro se ejecuta antes de que la API procese una solicitud entrante y permite reestructurar parámetros, validar entradas o inyectar contexto. Un posfiltro se ejecuta después de que la API devuelve los resultados y permite transformar, enriquecer u ocultar la respuesta.
Cómo funcionan los filtros de API
DataService Studio es compatible con funciones Aviator y Python. Utilice DataService Studio para create functions, test, publish, and use functions. Una vez publicada la función, asóciela con una API para usarla como filtro. De este modo, podrá atender distintos requisitos de consulta y adaptarse a diversos escenarios de negocio sin modificar la lógica principal de la API. Para obtener más información, consulte Use a function as an API filter.
Un prefiltro preprocesa los parámetros de solicitud de una API antes de que esta atienda la llamada.
Un posfiltro transforma los resultados devueltos por una API después de que esta atiende la llamada.
Para ver ejemplos de código de escenarios comunes, consulte Best practices: Use an Aviator function as a filter.
Requisitos
El prefiltro y el posfiltro de una API deben usar el mismo tipo de función: ambos Aviator o ambos Python. No se admite combinar tipos de función distintos en el prefiltro y el posfiltro de una misma API.
-
Por motivos de seguridad y rendimiento, las funciones Aviator deben ejecutarse en un exclusive resource group for DataService Studio.
Al editar o probar una función, adjúntele un resource group exclusivo para DataService Studio. Para obtener más información, consulte Create a function.
Si durante el desarrollo de una API habilita un filtro y asocia una función de destino, adjunte un resource group exclusivo para DataService Studio a dicha API. Para obtener más información, consulte Generate an API in the codeless UI.
Limitaciones
La función de filtros requiere DataWorks Basic Edition o una versión posterior.
Las funciones Python se encuentran en proceso de actualización. Por lo tanto, no es posible crear, clonar ni publicar nuevas funciones Python. En su lugar, utilice el tipo de función Aviator. Para obtener más información, consulte Create an Aviator function.