Repolode
encode

encode/django-rest-framework

シリアライズ、認証ポリシー、viewset、Browsable APIを備えた、Django上でWeb APIを構築するためのツールキット。

スター
30,210
フォーク
7,091
未解決の Issue
58
最終コミット
10 時間前

これは何?

Django REST framework(DRF)は、Django上でWeb APIを構築するためのツールキットです。Django ORMモデルとORMを使わないデータソースの両方から、JSONなどの形式に変換するシリアライザーと、受信リクエストに対する対応するバリデーション機能を提供します。

プレーンな関数ベースのビューから、汎用的なクラスベースのビューやviewsetまで、さまざまなビュー形式を利用できます。また、URL設定を自動生成するルーターも備えています。認証と権限のポリシーが組み込まれており、オプションのパッケージを追加するとOAuth1aとOAuth2をサポートできます。

主な機能のひとつがBrowsable APIです。開発者はこのWebインターフェースを使って、ブラウザー上でエンドポイントを直接調べたりテストしたりできます。Python 3.10以降が必要で、最近のDjango 5.2、6.0、6.1の各リリースに対応しています。

主な機能

  • 01シリアライザーはORMモデルとプレーンなデータソースの両方に対応します。
  • 02Browsable APIを使うと、ブラウザー上でエンドポイントをテストできます。
  • 03認証と権限のポリシーを標準で備え、オプションのOAuth1aおよびOAuth2パッケージも利用できます。
  • 04viewsetとルーターにより、一貫性のあるエンドポイントとURL設定を自動生成できます。
  • 05より細かな制御が必要な場合は、関数ベースのビューも引き続き利用できます。

ユースケース

  • DjangoモデルをJSONエンドポイントとして公開し、シングルページアプリケーションやモバイルアプリのフロントエンドに提供する。
  • 開発者向けの閲覧可能なドキュメントを備えた社内APIを構築する。
  • 既存のDjangoアプリケーションのAPIにOAuth2認証を追加する。

クイックスタート

  1. 1

    pipでパッケージをインストールします

    pip install djangorestframework
  2. 2

    settingsのINSTALLED_APPSに'rest_framework'を追加します

  3. 3

    開発サーバーを起動して、ブラウズ可能なAPIを開きます

    ./manage.py runserver

使う前に知っておきたいこと

  • Python 3.10以降とDjango 5.2、6.0、または6.1が必要です。
  • メタデータ上のライセンスはNOASSERTIONと記載されています。商用利用の前にライセンスファイルを確認してください。

トピック

よくある質問

django-rest-framework とは?
シリアライズ、認証ポリシー、viewset、Browsable APIを備えた、Django上でWeb APIを構築するためのツールキット。 Django REST framework(DRF)は、Django上でWeb APIを構築するためのツールキットです。Django ORMモデルとORMを使わないデータソースの両方から、JSONなどの形式に変換するシリアライザーと、受信リクエストに対する対応するバリデーション機能を提供します。
django-rest-framework は無料で使えますか?ライセンスは?
django-rest-framework は Other ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
django-rest-framework は今もメンテナンスされていますか?
活発にメンテナンス中。django-rest-framework の最終コミットは 2026年10月20日 です。
django-rest-framework は何に使えますか?
DjangoモデルをJSONエンドポイントとして公開し、シングルページアプリケーションやモバイルアプリのフロントエンドに提供する。 開発者向けの閲覧可能なドキュメントを備えた社内APIを構築する。 既存のDjangoアプリケーションのAPIにOAuth2認証を追加する。
django-rest-framework のインストール方法は?
pipでパッケージをインストールします: pip install djangorestframework settingsのINSTALLED_APPSに'rest_framework'を追加します 開発サーバーを起動して、ブラウズ可能なAPIを開きます: ./manage.py runserver
django-rest-framework はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/encode/django-rest-framework

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト