Django-filter: フィルタフィールドは、すべてのDRFビューアクションで技術的に許可されています。 これはCoreAPIスキーマを台無しにします。

DRFとDjangoFilterBackendを有効にしてCoreAPIを使用する場合、クライアントは、create、update、またはpartial_updateアクションのすべてのフィールドをクエリパラメーターにもマップしようとします。 これにより、これらのメソッドを使用するクライアントの機能が損なわれます。

例

名前を使用して本を作成しようとするリクエストがあり、名前もモデルのフィルター可能なフィールドである場合：

# book views
class BookViewSet():
    filter_fields = ('name',)
   # ...

// schema
client.action('book', 'create', { 'name': 'My Awesome Book' });

これにより、URLパラメータとリクエスト本文の両方に名前が含まれるリクエストが作成されます。 これは予期された動作ではありません。

POST /api/book?name=My%20Awesome%20Book

name=My Awesome Book

提案された解決策

代わりに、DRFフィルターバックエンドを次のコードでカスタムオーバーライドにポイントすることで、コードでこれを修正しました。

class OnlyFilterOnReadDjangoFilterBackend(DjangoFilterBackend):
    """ A filter backend that only allows for filtering by properties on
    actions deemed as safe. This means that create, update, and partial_update
    actions will not provide filter options.
    """
    SAFE_ACTIONS = ('list', 'retrieve')

    def get_schema_fields(self, view):
        if view.action in self.SAFE_ACTIONS:
            return super().get_schema_fields(view)
        return []