API フィルターは、API のコア実装を変更することなく、カスタムロジックをアタッチできる機能です。プレフィルターは、API が受信リクエストを処理する前に実行されることで、パラメーターの再形成、入力の検証、コンテキストの挿入が可能になります。ポストフィルターは、API が結果を返した後に実行されることで、レスポンスの変換、エンリッチ化、マスキングが可能になります。
API フィルターの仕組み
DataService Studio は、Aviator および Python の関数をサポートしています。DataService Studio を使用して、関数の作成、関数のテスト、パブリッシュ、使用ができます。関数をパブリッシュした後、その関数を API に関連付けてフィルターとして使用します。これにより、API のコアロジックを変更することなく、さまざまなクエリ要件の処理や、ビジネスシナリオへの適応が可能になります。詳細については、「関数を API フィルターとして使用」をご参照ください。
プレフィルターは、API がリクエストを処理する前に、そのリクエストパラメーターを前処理します。
ポストフィルターは、API がリクエストを処理した後に、その実行結果を変換します。
一般的なシナリオのコード例については、「ベストプラクティス:Aviator 関数をフィルターとして使用する」をご参照ください。
要件
API のプレフィルターとポストフィルターは、同じ関数タイプ (両方とも Aviator または両方とも Python) を使用する必要があります。同じ API のプレフィルターとポストフィルターで、異なる関数タイプを混在させることはできません。
セキュリティとパフォーマンスのため、Aviator 関数は DataService Studio 専用リソースグループ で実行する必要があります。
関数を編集またはテストする際は、その関数に DataService Studio 専用リソースグループをアタッチしてください。詳細については、「関数の作成」をご参照ください。
API を開発する際、フィルターを有効にしてターゲット関数を関連付ける場合は、API に DataService Studio 専用リソースグループをアタッチしてください。詳細については、「コードレス UI での API の生成」をご参照ください。
制限事項
フィルター機能には、DataWorks Basic Edition 以降のバージョンが必要です。
Python 関数はアップグレード中です。新しい Python 関数の作成、クローン、パブリッシュはできません。代わりに Aviator 関数タイプを使用してください。詳細については、「Aviator 関数の作成」をご参照ください。