Django的Web API，易于使用。
项目描述
Django REST framework
出色的Web可浏览Web API。
项目的完整文档可在https://django-rest-framework.django.ac.cn/找到。
资金
REST 框架是一个共同资助的项目。如果您在商业上使用 REST 框架，我们强烈建议您通过订阅付费计划来投资其持续发展。
最初的目标是为 REST 框架提供一份全职职位。 每一个注册都将对实现这一点产生重大影响。
非常感谢我们所有的杰出赞助商，特别是我们的高级赞助商，包括Sentry、Stream、Spacinov、Retool、bit.io、PostHog、CryptAPI、FEZTO和Svix。
概述
Django REST framework 是一个用于构建 Web API 的强大且灵活的工具包。
您可能会选择使用 REST 框架的几个原因
- Web 浏览器 API 为您的开发者带来了巨大的易用性提升。
- 身份验证策略包括可选的OAuth1a和OAuth2包。
- 序列化支持ORM和非 ORM数据源。
- 完全可定制 - 如果您不需要更多 强大 功能，只需使用基于函数的视图即可。
- 丰富的文档和优秀的社区支持。
以下：可浏览 API 的截图
要求
- Python 3.8+
- Django 5.0, 4.2
我们强烈推荐并仅官方支持每个 Python 和 Django 系列的最新补丁版本。
安装
使用 pip 安装...
pip install djangorestframework
将 'rest_framework' 添加到您的 INSTALLED_APPS 设置中。
INSTALLED_APPS = [
...
'rest_framework',
]
示例
让我们快速看一下使用 REST 框架构建一个简单的基于模型的 API，用于访问用户和组的例子。
启动一个新的项目...
pip install django
pip install djangorestframework
django-admin startproject example .
./manage.py migrate
./manage.py createsuperuser
现在编辑您项目中的 example/urls.py 模块
from django.contrib.auth.models import User
from django.urls import include, path
from rest_framework import routers, serializers, viewsets
# Serializers define the API representation.
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
fields = ['url', 'username', 'email', 'is_staff']
# ViewSets define the view behavior.
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
# Routers provide a way of automatically determining the URL conf.
router = routers.DefaultRouter()
router.register(r'users', UserViewSet)
# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
path('', include(router.urls)),
path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
]
我们还想为我们的 API 配置一些设置。
将以下内容添加到您的 settings.py 模块中
INSTALLED_APPS = [
... # Make sure to include the default installed apps here.
'rest_framework',
]
REST_FRAMEWORK = {
# Use Django's standard `django.contrib.auth` permissions,
# or allow read-only access for unauthenticated users.
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly',
]
}
这就完成了！
./manage.py runserver
现在您可以在浏览器中打开 API，地址为 http://127.0.0.1:8000/，并查看您的新 'users' API。如果您使用右上角的 Login 控件，您还可以添加、创建和删除系统中的用户。
您还可以使用命令行工具（如 curl）与 API 交互。
$ curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/
[
{
"url": "http://127.0.0.1:8000/users/1/",
"username": "admin",
"email": "admin@example.com",
"is_staff": true,
}
]
例如，列出用户端点
$ curl -X POST -d username=new -d email=new@example.com -d is_staff=false -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/
{
"url": "http://127.0.0.1:8000/users/2/",
"username": "new",
"email": "new@example.com",
"is_staff": false,
}
或创建一个新用户
项目的完整文档可在https://django-rest-framework.django.ac.cn/找到。
文档 & 支持
有关问题和支持，请使用REST 框架讨论组，或在 libera.chat IRC 的 #restframework 上。
请参阅安全策略。
下载文件
下载适用于您平台的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
源分发
构建版本
djangorestframework-3.15.2.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 36fe88cd2d6c6bec23dca9804bab2ba5517a8bb9d8f47ebc68981b56840107ad |
|
| MD5 | b0a078e9cd7b9f65acf554154c761b99 |
|
| BLAKE2b-256 | 2cce31482eb688bdb4e271027076199e1aa8d02507e530b6d272ab8b4481557c |
djangorestframework-3.15.2-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 2b8871b062ba1aefc2de01f773875441a961fefbf79f5eed1e32b2f096944b20 |
|
| MD5 | 190c58866c2a73c66570a1f6715a1df4 |
|
| BLAKE2b-256 | 7cb6fa99d8f05eff3a9310286ae84c4059b08c301ae4ab33ae32e46e8ef76491 |