質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.49%

Django rest framework におけるviews.py の書き分け

解決済

回答 1

投稿 編集

  • 評価
  • クリップ 0
  • VIEW 1,001

score 20

Django rest framework を勉強しています。
主にこのサイト公式ガイドを参照しました。

views.pyの書き方や継承元クラスはいくつかありますが、
とりあえず自分なりに理解した各方法の特長は以下の感じです

### views

`function view`
    * responseを受け取りResponseを返却する。URLにパラメータを埋め込む場合は引数を増やしたりする
    * 単純な機能は関数ベースで書いたほうが逆に可読性がよく保守しやすいかも

`class view`
    * APIView クラスを継承して定義する。 対象のHTTPメソッドがそのまま インスタンスメソッド になる。→ハンドラメソッド
    * 特定のモデルに紐付かないような処理はクラスベースで記述したほうがいい

`generic view (汎用ビュー)`
    * 用意されたいろいろなクラスを継承してつくるビューで、やりたいことを簡単に実装できる
    * 提供されるメソッドはcreate()、update()、list()など



### viewsets

`viewsets.ViewSet`
    * APIViewを継承していて、permission_classesやauthenticationなどの属性を利用できる
    * アクションの実装が提供されていないので、クラスをオーバーライドして自分で定義する必要がある
    * RESTapiに対応するメソッドが提供される。create()、update()、list()など
    * メソッドの中でquerysetやserializerを指定し、Response()を返す
    * urls.pyでUserViewSet.as_view()としてメソッドを指定する必要がある?
    * basename、action、detailなどのインスタンス変数が用意されていて、現在のアクションに基づいて動作を調整できる?

`viewsets.ModelViewSet`
    * GenericAPIViewを継承していて、様々なアクションのための実装を含んでいる
    * クラス変数としてquerysetとserializer_classを指定する。時々permission_classesも
    * @actionデコレータを使ってメソッドを定義する。requestを受け取る
    * self.get_object()やself.get_serializerなどのインスタンスメソッドが用意されている
    * url^モデル名/{pk}/メソッド名/$でアクションにアクセスできるようになる

`viewsets.GenericViewSet`
    * GenericAPIViewを継承していて、get_object()やget_queryset()などを提供するが、デフォルトではアクションは提供されていない  

しかし、どういった使い分けをするのかいまいちイメージできないので、「こんな機能を実装したい場合はこの方法が適している」 のような具体例をいくつかお願いできないでしょうか
例えば、「画像をpostしたときに、加工してからデータベースに保存する場合はどれがいい」 のような感じです

よろしくお願いします

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

0

私は下記のように使い分けています。

APIViewは、特定の1つのモデルに紐づかない場合に使用します。

Generic Viewは、特定のモデルに対して、リスト、詳細、更新(一部更新)及び削除の機能をうち、1つか2つ程度しか提供しない場合に使用します。

ModelViewsetは、Generic Viewと異なり、特定のモデルに対して、それら一連の機能を提供したい場合に使用します。

関数ベースドなビューやGenericViewsetは使用したことがありません。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2020/08/24 19:01 編集

    ViewSetを使わなくてもある程度の機能は実現できるということですね

    hasamiさんの使い方としては以下であってますでしょうか?

    特定のモデルに紐づかない━CURD操作を少しだけ使いたい ━→ APIView
    特定のモデルに紐づかない━CURD操作を全て使いたい ━→ APIView
    特定のモデルに紐づく━CURD操作を少しだけ使いたい ━→ GenericView
    特定のモデルに紐づく━CURD操作を全て使いたい ━→ ModelViewSet

    キャンセル

  • 2020/08/24 20:48

    そのような感じですが、APIViewの使用は、複数の異なるモデルのインスタンスの参照か、システム状態提供などモデルに全く関係ない場合に限定されることが多いです。

    キャンセル

  • 2020/08/26 14:58

    なるほど、ありがとうございます。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.49%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る