django rest framework构建Web API之框架安装篇
laoyan 2018-01-15 22:13:57
分 享

django rest framework构建Web API之框架安装篇logo1.png


1、背景简介


Django REST framework框架(简称DRF)是一个用于构建Web API的强大而灵活的工具。我们为什么需要使用REST Framework框架呢?以下列出了一些原因:


(1)基于Web可浏览的API能让你赢得更多开发者
(2)支持OAuth1a和OAuth2的认证机制
(3)Serialization序列化支持ORM和non-ORM的数据源
(4)如果你不需要更为强大的功能,则你可以自定义只使用常规的函数功能视图
(5)大量的文档,广大的社区支持
(6)得到去多大公司使用和信任,如Mozilla、Red Hat红帽、Eventbrite等都在使用它


2、环境要求


Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
Django (1.10, 1.11, 2.0)


以下是DRF的可选安装包:


coreapi (1.32.0+) - 支持模式(概要视图)生成
Markdown (2.1.0+) -  Markdown 支持可浏览的API
django-filter (1.0.1+) - 支持过滤
django-crispy-forms - 改进的HTML显示过滤
django-guardian (1.1.1+) - 支持对象级权限控制


3、安装配置(以下已经安装了django2.0和python3.6为例)


(1)安装djangorestframework以及自己选择的可选安装包


pip install djangorestframework
pip install coreapi   #可选
pip install markdown #可选
pip install django-filter #可选
pip install django-crispy-forms  #此安装包在安装xadmin的时候也依赖此包
pip install django-guardian #可选


(2)新建django项目和app并初始化数据库并创建管理员


django-admin startproject lybbndrfs
cd lybbndfrs
python manage.py startapp lydrf
python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser


(3)在django项目的settings.py的INSTALLED_APPS中添加rest_framework和app应用lydrf


INSTALLED_APPS = (
    ...
    'lydrf',
    'rest_framework',
)


(4)在django的app中新建serializers.py文件并设置如下内容


from django.contrib.auth.models import User, Group
from rest_framework import serializers
class UserSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = User
        fields = ('url', 'username', 'email', 'groups')
class GroupSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Group
        fields = ('url', 'name')



(5)在django的app的views.py文件中设置如下内容


from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from lydrf.serializers import UserSerializer, GroupSerializer
class UserViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer
class GroupViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows groups to be viewed or edited.
    """
    queryset = Group.objects.all()
    serializer_class = GroupSerializer


(6)在django项目的urls.py中添加djangorestframework的可访问的url路径


from django.conf.urls import url, include
from rest_framework import routers
from lydrf import views
router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)
# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
    url(r'^', include(router.urls)),
    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]


(7)运行django项目


python manage.py runserver


(8)通过浏览器访问http://127.0.0.1:8000,可以看到刚刚添加的两个视图函数和urls


django rest framework构建Web API之框架安装篇01.png



4、官方网址


http://www.django-rest-framework.org/
https://github.com/encode/django-rest-framework/tree/master


我要小额支持下

取消

感谢您的支持,我会继续努力的!

扫码支持
扫码打赏,你说多少就多少

打开支付宝扫一扫,即可进行扫码打赏哦

取消
吐槽一下

游客

所有吐槽
  • 暂时还没有吐槽,赶紧来吐槽!