Python Django 入門トップページ


Django REST Framework による API 開発

  1. API とプロジェクトの概要
  2. Django REST Frameworkのインストール
  3. プロジェクトの作成
  4. 基本設定
  5. アプリケーションの作成と登録
  6. モデルの作成とマイグレーション
  7. テストデータの設定
  8. コメント一覧を出力する API
  9. コメント詳細情報を出力する API
  10. 新規投稿と更新・削除の API
  11. ページネーション
  12. 入力内容の検証(バリデーション)
  13. テストの自動化
  14. Shell でのユーザ登録
  15. Fixtures でのユーザ登録
  16. ユーザ認証を必須にする
  17. コメントにオーナ情報を追加
  18. 権限の設定:Case #1
  19. 権限の設定:Case #2
  20. Python から API への接続
  21. React アプリケーションからの API 接続と CORS エラーの回避

Django REST Framework による API 開発

API とプロジェクトの概要

API とは

API (Application Programming Interface) は,ソフトウェアの機能の一部を他のプログラムからも利用できるようにするためのインタフェースです.特に REST API は REST (Representational State Transfer) の4原則に則った API で,この4原則は次のとおりです.

  1. 統一インタフェース
  2. アドレス可能性
  3. 接続性
  4. ステートレス性

例えば,X(旧Twitter)ではポスト(ツイート)を閲覧したり投稿したりするための API が公開されているため,Twitter の Web サイトや公式のスマホアプリだけでなく,第3者が公開したスマホアプリでポスト(ツイート)の閲覧,投稿ができます.

目次に戻る

ここでの概要

以前のページでは,コメントを投稿したり閲覧したりする掲示板を作成しました.また,このページでもユーザのログイン機能を備えた掲示板を作成しました.これら掲示板では特定の Web ページからしかアクセスできませんでした.ここではコメント掲示板とほぼ同じ機能を持つ掲示板の API バージョンを開発します.

具体的には,Django REST Framework というフレームワークを利用して API を作成します.これにより,決められた URI に http の GET や POST などのメソッドでリクエストを送信すると JSON 形式の結果が得られることになります.つまり,自分で開発した別の Python プログラム,スマホアプリ,コマンドラインなどからコメントを閲覧したり投稿したりできるようになります.

サンプルプロジェクトのダウンロード

次のページからテストの自動化までの作業を行ったサンプルプロジェクトをGitHubで公開しているので,必要であればここからダウンロードしてください.

目次に戻る