Chapter 02無料公開

Django REST Frameworkとは?

はる@Python、Djangoプログラミング講師
はる@Python、Djangoプログラミング講師
2021.03.21に更新

Django REST Frameworkとは?

Django REST Frameworkとは、DjangoでAPIを開発するライブラリです。

公式ドキュメント

Django REST framework

RESTfulなAPI開発を標準としてサポートしています。

APIの動作を確認するWebコンソールが使用できるので、簡単にAPIパラメータの確認ができます。

RESTful API

ESTful API(REST API)とは?

RESTful API(REST API)とは、Webシステムを外部から利用するためのAPIの種類の一つで、RESTと呼ばれる設計に従ったインターフェースです。

RESTful

メソッド

GET、POST、PUT、DELETE等メソッドを使うことで、一貫性のあるリクエストで開発が楽になります。

データを取得、作成、更新、削除するのか一目でわかります。

メソッド 内容
GET 取得
POST 作成
PUT/PATCH 更新
DELETE 削除

ステータスコード

HTTPメソッドを利用したAPIなので、下記のステータスコードが返ってくるように設計します。

状態 ステータスコード
OK 200
Created 201
Bad Request 400
Unauthorized 401
Forbidden 403
Not Found 404
Method Not Allowed 405

ステータスコードグループ

ステータスコードはグループになっています。

ステータスコード 内容
1xx 情報
2xx 成功
3xx リダイレクト
4xx クライアントエラー
5xx サーバーエラー

API例

URL HTTP 内容 ステータスコード
/posts/ GET すべてのリストを取得 200 OK
/posts/1/ GET 特定のpostを取得 200 OK
/posts/2/ (存在しない) GET エラーが発生 404 Not Found
/posts/ POST postを作成 201 Created
/posts/3 PUT 特定のpostを更新 200 OK
/posts/4 DELETE 特定のpostを削除 204 Not Content

Django REST Framework

Django REST Frameworkは、今までのDjangoにserializer.pyが追加されます。

serializer.pyはJson形式に変換する役割をします。

DRF