スポンサードリンク




Warning: simplexml_load_string(): Entity: line 1: parser error : Space required after the Public Identifier in /home/sinybog/sinyblog.com/public_html/wp/wp-content/plugins/yyi-rinker/yyi_rinker_main.php on line 1382

Warning: simplexml_load_string(): <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> in /home/sinybog/sinyblog.com/public_html/wp/wp-content/plugins/yyi-rinker/yyi_rinker_main.php on line 1382

Warning: simplexml_load_string(): ^ in /home/sinybog/sinyblog.com/public_html/wp/wp-content/plugins/yyi-rinker/yyi_rinker_main.php on line 1382

Warning: simplexml_load_string(): Entity: line 1: parser error : SystemLiteral " or ' expected in /home/sinybog/sinyblog.com/public_html/wp/wp-content/plugins/yyi-rinker/yyi_rinker_main.php on line 1382

Warning: simplexml_load_string(): <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> in /home/sinybog/sinyblog.com/public_html/wp/wp-content/plugins/yyi-rinker/yyi_rinker_main.php on line 1382

Warning: simplexml_load_string(): ^ in /home/sinybog/sinyblog.com/public_html/wp/wp-content/plugins/yyi-rinker/yyi_rinker_main.php on line 1382

Warning: simplexml_load_string(): Entity: line 1: parser error : SYSTEM or PUBLIC, the URI is missing in /home/sinybog/sinyblog.com/public_html/wp/wp-content/plugins/yyi-rinker/yyi_rinker_main.php on line 1382

Warning: simplexml_load_string(): <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> in /home/sinybog/sinyblog.com/public_html/wp/wp-content/plugins/yyi-rinker/yyi_rinker_main.php on line 1382

Warning: simplexml_load_string(): ^ in /home/sinybog/sinyblog.com/public_html/wp/wp-content/plugins/yyi-rinker/yyi_rinker_main.php on line 1382

こんにちは。sinyです。

本記事では、Django REST Framework(DRF)を使った簡単なAPIの作成手順をまとめました。

エンドポイントに対して銀行名を与えてGETメソッドを投げると支店名一覧を返すような簡単なREST APIを作成していきます。

環境

今回は以下のバージョンで環境構築しました。

モジュール一覧
  • Django (3.0)
  • django-filter (2.2.0)
  • djangorestframework (3.10.3)

事前準備

Django REST Frameworkを作成する前の事前準備を行います。

モジュールのインストール

仮想環境を作成後に以下のコマンドでモジュールをインストールします。

 

プロジェクト、アプリケーションの作成

Django REST Frameworkを作成するためにdjagnoプロジェクトとアプリケーションを作成します。

 

settings.pyの設定

settings.pyにアプリケーションとrest_frameworkを追加します。

 

Django REST Frameworkの作成

つづいて、Django REST Frameworkの作成です。

DjangoでDjango REST Frameworkを作成するには最低限以下の3つを定義する必要があります。

構成要素
  • Serializer
  • ViewSet
  • URL pattern

なお、ケースによりますが通常はモデルの定義も必要になってきます。

モデルの定義(models.py)

今回は以下のような銀行名と支店名コードのテーブルを例にDjango REST Frameworkを作成していきます。

 

Serializerの定義(serializer.py)

 

Django REST Frameworkにおけるシリアライズ、デシリアライズは以下のような処理を表します。

シリアライズ     JSON文字列などをDjangoモデルオブジェクトに変換すること 
デシリアライズ モデルオブジェクトからJSON形式などに変換すること

 

また、Django REST Frameworkのシリアライザーには大きく以下の3種類があります。

serializerの処理 意味
ModelSerializer        単一のモデルオブジェクトを利用 
Serializer 単一のリソースを扱う、またはモデルに依存しないカスタマイズな処理を実装する
ListSerializer 複数リソースを扱う

 

今回は、Djangoモデル定義をそのまま活用するのでModelSerializerを使っていきます。

appv1/serializer.pyを作成し、以下のコードを記載します。

 

ModelSerializerを使うと非常に簡単にREST APIのシリアライザを定義することができます。

Metaクラス内にmodel属性としてmodels.pyで定義したモデルクラス名を指定します。
そして、fieldsにAPIとして出力したいフィールド名を指定してあげます。

fields属性は以下のように指定可能です。

  • リストorタプル形式で指定
  • すべてのフィールドを指定する場合は「__all__
  • 除外設定した場合は、exclude = [branch_code']のようにする。

今回は銀行名を扱うBankSerializerシリアライザと銀行の支店名を扱うBranchSerializerの2つを定義しました。

 

ViewSetの定義(views.py)

続いてビューの定義です。
今回はrest_frameworkのModelViewSetを使います。

querysetにはすべてのレコードを格納するようにします。
serializer_classには利用したいシリアライザクラス(serializer.pyで定義したクラス)を指定します。

 

URL pattern定義

次にアプリケーション配下にurls.pyを作成して以下を定義します。

 

ここでは、Django REST Frameworkのroutersというものを使ってModel毎に以下のようなURLパターンを定義しています。

  • GET /api/bank/ でBankモデルの一覧を取得
  • GET /api/branches/ でBranchモデルの一覧を取得

次にプロジェクト配下のurls.pyで先ほど定義したアプリケーションのurls.pyをインクルードしてあげます。

 

テストデータの登録

 

ここまできたら、一旦マイグレーション、管理者ユーザの作成後にrunserverします。

 

次にadmin画面からテストデータを登録するためにadmin.pyに以下を定義します。

 

http://127.0.0.1:8000/adminにアクセスして銀行と支店情報をいくつか登録しておきます。

今回は4つの銀行と、三井住友の支店情報を4つだけ登録しておきます。

【銀行情報】

【支店情報】

 

 

API動作確認

 

開発サーバが起動したらhttp://127.0.0.1:8000/api/にアクセスして以下のようなAPIの画面が表示されることを確認します。

次に、銀行名の一覧表示用Rest API(http://127.0.0.1:8000/api/bank/)にアクセスして以下のように銀行名の一覧が表示されればOKです。

PK=1の銀行名のレコード(三井住友)にアクセスするにはhttp://127.0.0.1:8000/api/bank/1/のようにアクセスします。

ClientからJson形式でデータを取得する。

 

まず、クライアントPCのブラウザからhttp://127.0.0.1:8000/api/bank/?format=jsonのようにアクセスすると、以下のようにJSON形式で銀行名の一覧情報を取得できます。

 

curlコマンドで取得した場合はcurl http://127.0.0.1:8000/api/bank/?format=json実行します。
※文字化けする場合はchcp 65001を実行

pythonコマンドから取得したい場合は以下のようなコードを実行します。
※以下は銀行名の一覧を抽出する例

 

カスタマイズ

 

次に支店情報一覧のAPI(http://127.0.0.1:8000/api/branches/)にアクセスしてみましょう。
以下の通り支店情報の一覧が表示されますが、bank_name(銀行名)の部分が外部テーブル参照になっている関係でPK番号で表示されていてちょっとわかりにくいです。

外部参照キーになっているbank_nameがPKキー表示になっているので、名称表示に変えてみます。

serializer.pyで定義したBranchSerializerクラスに以下のコードを追加します。

 

先ほどの画面を更新すると以下の通りbank_nameの部分がpk番号→銀行名、銀行コードに変わります。

ペジネーション

 

Django REST Frameworkで1回のリクエストで取得できる件数を制限し、必要に応じて次ページ分のデータを取得できるようにします。
ページネーションはsettings.pyに以下を追加するだけです。

 

その後画面を更新すると以下の赤枠のようにページネーション機能が追加されます。

フィルタ機能

 

次に、Django REST Frameworkにフィルタ機能を追加してみます。
フィルタ機能を利用するにはsettings.pyのINSTALLED_APPに「 'django_filters',」を追加します。
※django_filtersは最初にpipでインストール済み。

 

さらにsettings.pyREST_FRAMEWORKDEFAULT_FILTER_BACKENDSを以下の通り追加します。

 

次にviews.pyのBranchViewSetにfilter_fields属性を追加します。
今回は銀行名でフィルタするものとします。

 

画面を更新すると、以下の通りFiltersボタンが追加され、銀行名でフィルタ検索できるようになります。

ちなみにこの時、URLは「http://127.0.0.1:8000/api/branches/?bank_name=1のようになっています。

通常リクエスト投げるときはbank_name=1という指定方法ではなく、銀行名を渡してリクエストの結果を受け取るという使い方が多いと思います。
先ほど設定したviews.pyのfilter_filedsの設定をbank_name → bank_name__nameに変更します。

これで、「http://127.0.0.1:8000/api/branches/?format=json&bank_name__name=<銀行名>'」という形式でリクエストを投げれるようになります。

 

以下は、pythonコードでGETリクエスト('http://127.0.0.1:8000/api/branches?format=json&bank_name__name=三井住友)を投げる例です。

 

お勧めの書籍

Django REST Frameworkについては下記リンクの公式チュートリアルがあります(英語)

上記チュートリアルもわかりやすくて勉強になりますが、日本語書籍でDjango REST Frameworkに関するおすすめ書籍を1冊紹介しておきます。

akiyokoさんが執筆販売している書籍ですが、導入部では初心者の方にもわかりやすくDRFの概念やクラスの種類などが紹介されています。

かなり細部にわたってDjango REST Frameworkの仕組みを解説しているため、今後DRFを活用していきたい方は是非読んでおくことをお勧めします。

以上、「Django REST Frameworkで簡単なREST APIを実装する方法」でした。

おすすめの記事