Repolode
encode

encode/django-rest-framework

基于 Django 构建 Web API 的工具包,提供序列化、认证、视图集和可浏览的 API 界面。

Star
30,210
Fork
7,091
未关闭 Issue
58
最近提交
9小时前

这是什么?

Django REST framework(DRF)是一个基于 Django 构建 Web API 的工具包。它提供序列化器,可以将 Django ORM 模型及非 ORM 数据源转换为 JSON 等格式,并负责对请求数据进行校验。

框架支持多种视图写法,从普通的函数视图,到通用类视图和视图集,并提供可自动生成 URL 配置的路由器。内置认证与权限机制,同时可通过可选包接入 OAuth1a 和 OAuth2。

其特色之一是可浏览的 API 界面,开发者可以直接在浏览器中查看和测试接口。项目要求 Python 3.10 及以上版本,支持 Django 5.2、6.0 和 6.1。

核心功能

  • 01序列化器同时支持 ORM 模型和普通数据源。
  • 02可浏览的 API 界面,便于在浏览器中测试接口。
  • 03内置认证与权限机制,可选接入 OAuth1a 和 OAuth2。
  • 04视图集与路由器可自动生成一致的接口和 URL 配置。
  • 05需要更多控制时,仍可使用函数视图。

适用场景

  • 将 Django 模型暴露为 JSON 接口,供单页应用或移动端调用。
  • 构建带有可浏览界面的内部 API,方便开发团队调试。
  • 为已有 Django 应用的 API 增加 OAuth2 认证。

快速上手

  1. 1

    使用 pip 安装该包

    pip install djangorestframework
  2. 2

    在设置中的 INSTALLED_APPS 里添加 'rest_framework'

  3. 3

    启动开发服务器并打开可浏览的 API

    ./manage.py runserver

使用前须知

  • 需要 Python 3.10 及以上版本以及 Django 5.2、6.0 或 6.1。
  • 元数据中的许可证显示为 NOASSERTION,商业使用前请先查看许可证文件。

标签

常见问题

django-rest-framework 是什么?
基于 Django 构建 Web API 的工具包,提供序列化、认证、视图集和可浏览的 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 在设置中的 INSTALLED_APPS 里添加 'rest_framework' 启动开发服务器并打开可浏览的 API: ./manage.py runserver
在哪里获取 django-rest-framework?
源代码和安装说明在 GitHub 上:https://github.com/encode/django-rest-framework

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目