Django REST framework 技术文档
1. 安装指南
首先,确保您的环境中已经安装了 Python 3.8 或更高版本以及 Django 4.2, 5.0, 或 5.1。推荐使用最新版本的 Python 和 Django。
使用 pip 安装 Django REST framework:
pip install djangorestframework
然后,在您的 Django 项目的 settings.py
文件中,将 'rest_framework'
添加到 INSTALLED_APPS
列表中:
INSTALLED_APPS = [
...
'rest_framework',
]
2. 项目的使用说明
Django REST framework 是一个强大的工具包,用于构建 Web APIs。以下是如何快速开始使用这个框架的步骤:
-
创建项目:使用 Django 的命令创建一个新项目。
pip install django django-admin startproject example .
-
迁移数据库:执行数据库迁移以创建必要的表。
./manage.py migrate
-
创建超级用户:创建一个超级用户以便于管理。
./manage.py createsuperuser
-
编辑
urls.py
:在项目目录下的urls.py
文件中配置 URL 路由。from django.contrib import admin from django.urls import path, include from rest_framework import routers, serializers, viewsets from django.contrib.auth.models import User # 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. urlpatterns = [ path('', include(router.urls)), path('admin/', admin.site.urls), path('api-auth/', include('rest_framework.urls', namespace='rest_framework')), ]
-
配置
settings.py
:在settings.py
文件中配置 REST framework。REST_FRAMEWORK = { 'DEFAULT_PERMISSION_CLASSES': [ 'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly', ] }
-
运行服务器:启动 Django 开发服务器。
./manage.py runserver
现在,您可以在浏览器中打开 http://127.0.0.1:8000/
,查看新的 'users' API。
3. 项目API使用文档
Django REST framework 提供了丰富的 API 功能,包括序列化、视图、权限、认证等。以下是一些基础的使用示例:
-
获取用户列表:
curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/
-
创建新用户:
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/
更多 API 使用和配置细节,请参考官方文档。
4. 项目安装方式
如上所述,使用 pip 是安装 Django REST framework 最简单的方式:
pip install djangorestframework
确保将 'rest_framework'
添加到您的 Django 项目的 INSTALLED_APPS
中。
以上就是关于 Django REST framework 的技术文档,希望对您有所帮助。如果您有任何问题或需要进一步的帮助,请参考官方文档或加入相关社区进行讨论。
- QQwen3-Omni-30B-A3B-InstructQwen3-Omni是多语言全模态模型,原生支持文本、图像、音视频输入,并实时生成语音。00
- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0269get_jobs
💼【AI找工作助手】全平台自动投简历脚本:(boss、前程无忧、猎聘、拉勾、智联招聘)Java00AudioFly
AudioFly是一款基于LDM架构的文本转音频生成模型。它能生成采样率为44.1 kHz的高保真音频,且与文本提示高度一致,适用于音效、音乐及多事件音频合成等任务。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile08
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选









