1 参考博客:

http://blog.csdn.net/SVALBARDKSY/article/details/50548073

    

2  准备工作

1. 环境

Python: Python 3.5
Django: 1.9
django-filter: 0.11.
djangorestframework: 3.3.

 2.准备工作

安装库

pip install django
pip install djangorestframework
pip install django-filter 创建工程 app
django-admin startproject django_rest_framework_test
cd django_rest_framework_test/ python manage.py startapp blog

 3.定义Model

from django.db import models
class User(models.Model):
name = models.CharField(max_length=)
mail = models.EmailField()

  .admin注册

from django.contrib import admin
from blog.models import User
# Register your models here.
admin.register(User)

   4. 构建DB

# 添加程序 blog
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'blog',
]

  5.然后同步数据结构,默认使用Sqlite3.

python manage.py makemigrations
python manage.py migrate

  6.admi后台

# 创建管理用户
python manage.py createsuperuser
Username (leave blank to use 'kimihiro_n'): dev
Email address:
Password:
Password (again):
Superuser created successfully. # 启动服务器
python manage.py runserver

    

3  使用Djagno REST Framework

  1.添加APP REST Framework

#django_rest_framework_test/settings.py

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

  2.生成REST

  生成REST API最少需要定义下面3个。

  • - Serializer
  • - ViewSet
  • - URL pattern

  简单来说,Serializer是将「Model序列化」,ViewSet是API的应答器,URL Pattern定义了URL的路由。

  2.1定义Serialzier

  需要继承serializers.ModelSerializer, fields为API想要得到的字段。

#blog/serializer.py

# coding: utf-
from rest_framework import serializers
from .models import User, Entry class UserSerializer(serializers.ModelSerializer):
class Meta:
model = User
fields = ('name', 'mail')

    

   2.2定义ViewSet

  queryset设置为Model的queryset,serializer_class设置为刚才定义的serializer。

#blog/views.py

# coding: utf-

import django_filters
from rest_framework import viewsets, filters from .models import User, Entry
from .serializer import UserSerializer, EntrySerializer class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer

2.3定义URL pattern

#django_rest_framework_test/urls.py

# coding: utf-

from django.conf.urls import url, include
from django.contrib import admin from blog.urls import router as blog_router urlpatterns = [
url(r'^admin/', admin.site.urls),
#include blog.urls
url(r'^api/', include(blog_router.urls)),
]
#blog/urls.py

# coding: utf-

from rest_framework import routers
from .views import UserViewSet, EntryViewSet router = routers.DefaultRouter()
router.register(r'users', UserViewSet)
router.register(r'entries', EntryViewSet)

4测试API

python manage.py runserver

5. 未完成

自定义API

真正运用的时候,可能需要对抽选进行过滤。另外比如

将关系表数据同时获取

例如下面的数据

{
"title": "Hello, Django REST API!!",
"body": "<script>alert(\"hello\");</script>",
"created_at": "2015-12-09T05:59:46.200277Z",
"status": "draft",
"author":
} 返回的是author的ID。如果这样下次还要通过 /api/users/1再次请求User的数据。这样效率并不好,现在我们想获得下面的数据。 {
"title": "Hello, Django REST API!!",
"body": "<script>alert(\"hello\");</script>",
"created_at": "2015-12-09T05:59:46.200277Z",
"status": "draft",
"author": {
"name": "Alice",
"mail": "alice@example.com"
}
} 在Serializer里把author的部分,再次定义一下。 blog/serializer.py

class EntrySerializer(serializers.ModelSerializer):
# author的serializer
author = UserSerializer() class Meta:
model = Entry
fields = ('title', 'body', 'created_at', 'status', 'author') EntrySerializer 重新定义author,这样获取的时候会同时获得User信息。
其他的自定义方法请参照 http://www.django-rest-framework.org/api-guide/serializers/ 分页 现在获取数据都是全件获取,数据量非常大的时候,需要对数量进行限制。 django_rest_framework_test/settings.py
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
'PAGE_SIZE':
} 设置需要全局设置。在配置文件里,定义REST_FRAMEWORK,设置DEFAULT_PAGINATION_CLASS和PAGE_SIZE。
这样API会出现offset(开始位置)和limit(限制件数,
default=PAGE_SIZE)等参数。 {
"count": ,
"next": "http://localhost:8000/api/entries/?limit=2&offset=2",
"previous": null,
"results": [
{
"id": ,
"title": "Hello, Django REST Framework!!",
"body": "Hello!",
"created_at": "2015-12-12T11:55:22.310203Z",
"status": "draft",
"author":
},
{
"id": ,
"title": "The Zen of Python",
"body": "The Zen of Python, by Tim Peters\r\n\r\nBeautiful is better than ugly.\r\nExplicit is better than implicit.\r\nSimple is better than complex.\r\nComplex is better than complicated.\r\nFlat is better than nested.\r\nSparse is better than dense.\r\nReadability counts.\r\nSpecial cases aren't special enough to break the rules.\r\nAlthough practicality beats purity.\r\nErrors should never pass silently.\r\nUnless explicitly silenced.\r\nIn the face of ambiguity, refuse the temptation to guess.\r\nThere should be one-- and preferably only one --obvious way to do it.\r\nAlthough that way may not be obvious at first unless you're Dutch.\r\nNow is better than never.\r\nAlthough never is often better than *right* now.\r\nIf the implementation is hard to explain, it's a bad idea.\r\nIf the implementation is easy to explain, it may be a good idea.\r\nNamespaces are one honking great idea -- let's do more of those!",
"created_at": "2015-12-12T11:56:32.854278Z",
"status": "draft",
"author":
}
]
} next,previous都会带有URL,非常的方便。
其他方式,参照 http://www.django-rest-framework.org/api-guide/pagination/ 筛选 如果想通过author来筛选Entry时。 django_rest_framework_test/settings.py
REST_FRAMEWORK = {
'DEFAULT_FILTER_BACKENDS': ('rest_framework.filters.DjangoFilterBackend',)
} 在配置文件里添加DEFAULT_FILTER_BACKENDS。和分页所设置的是同一个字典。 class EntryViewSet(viewsets.ModelViewSet):
queryset = Entry.objects.all()
serializer_class = EntrySerializer
filter_fields = ('author', 'status') 然后在ViewSet里设置filter_fields。这样就可以通过author和status来筛选。
API后面为?author=,就会抽选User id=1的blog。?status=public会抽选已经公开的Blog
其他筛选方法参照 http://www.django-rest-framework.org/api-guide/filtering/ 参考URL http://qiita.com/kimihiro_n/items/86e0a9e619720e57ecd8
http://www.django-rest-framework.org/
http://www.slideshare.net/unsolublesugar/res-tful
http://qiita.com/KojiOhki/items/5be98eeae72dca2260bc
http://racchai.hatenablog.com/entry/2016/04/12/Django_REST_framework_%E8%B6%85%E5%85%A5%E9%96%80

8 REST Framework 实现Web API 1的更多相关文章

  1. 【ASP.NET MVC 5】第27章 Web API与单页应用程序

    注:<精通ASP.NET MVC 3框架>受到了出版社和广大读者的充分肯定,这让本人深感欣慰.目前该书的第4版不日即将出版,现在又已开始第5版的翻译,这里先贴出该书的最后一章译稿,仅供大家 ...

  2. Entity Framework 6 Recipes 2nd Edition(9-1)译->用Web Api更新单独分离的实体

    第九章 在N层结构的应用程序中使用EF 不是所有的应用都能完全地写入到一个单个的过程中(就是驻留在一个单一的物理层中),实际上,在当今不断发展的网络世界,大量的应用程序的结构包含经典的表现层,应用程, ...

  3. Entity Framework 6 Recipes 2nd Edition(9-3)译->找出Web API中发生了什么变化

    9-3. 找出Web API中发生了什么变化 问题 想通过基于REST的Web API服务对数据库进行插入,删除和修改对象图,而不必为每个实体类编写单独的更新方法. 此外, 用EF6的Code Fri ...

  4. Entity Framework 6 Recipes 2nd Edition(9-4)译->Web API 的客户端实现修改跟踪

    9-4. Web API 的客户端实现修改跟踪 问题 我们想通过客户端更新实体类,调用基于REST的Web API 服务实现把一个对象图的插入.删除和修改等数据库操作.此外, 我们想通过EF6的Cod ...

  5. 基于.Net Framework 4.0 Web API开发(2):ASP.NET Web APIs 参数传递方式详解

    概述:  ASP.NET Web API 的好用使用过的都知道,没有复杂的配置文件,一个简单的ApiController加上需要的Action就能工作.调用API过程中参数的传递是必须的,本节就来谈谈 ...

  6. 如何使用ASP.NET Web API OData在Oracle中使用Entity Framework 6.x Code-First方式开发 OData V4 Service

    环境: Visual Studio 2013 + .Net Framework 4.5.2 1.新建项目 2.安装OData,ODP.NET 安装的包: 下面是部分代码: using System; ...

  7. Web Api 2, Oracle and Entity Framework

    Web Api 2, Oracle and Entity Framework I spent about two days trying to figure out how to expose the ...

  8. [转]How to Use Web API OData to Build an OData V4 Service without Entity Framework

    本文转自:http://www.odata.org/blog/how-to-use-web-api-odata-to-build-an-odata-v4-service-without-entity- ...

  9. 基于.Net Framework 4.0 Web API开发(3):ASP.NET Web APIs 异常的统一处理Attribute 和统一写Log 的Attribute的实现

    概述:  ASP.NET Web API 的好用使用过的都知道,没有复杂的配置文件,一个简单的ApiController加上需要的Action就能工作.但是项目,总有异常发生,本节就来谈谈API的异常 ...

随机推荐

  1. Linux下安装软件遇见的问题汇总

    1.安装monodevelop 安装环境Linux Mint17.1 在软件在中心直接安装monodevelop,安装完成后直接启动界面“一闪而过”,解决办法: 软件中心安装 mono-complet ...

  2. vue $set用法

    需求,想给下面的数据添加一个hoby属性 {{data.hoby}}-->让这里的视图改变 data:{ name: "简书", age: '3', info: { cont ...

  3. pure响应式布局

    <!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <m ...

  4. redis空间键详解

    前言 redis的空间键通知是在2.8.0版本以后加入的,客户端通过发布订阅的方式,订阅某个频道,接收通过某种方式影响redis中数据的事件. 目录: 1.空间键事件分类 2.如何启用redis的空间 ...

  5. 【转】如何在Git中撤销一切

    翻译:李伟 审校:张帆译自:Github 任何一个版本控制系统中,最有用的特性之一莫过于 “撤销(undo)”操作.在Git中,“撤销”有很多种含义. 当你完成了一次新的提交(commit),Git会 ...

  6. 梦织未来Windows驱动编程 第06课 驱动对磁盘文件的操作

    代码部分: 实现一个文件C:\\text.txt,并读取写入内容到文件,然后将文件设置为只读,并隐藏文件.代码如下: //MyCreateFile.c //2016.07.22 #include &l ...

  7. 如何解决linux下apache启动时httpd: apr_sockaddr_info_get() failed for 报错

    今天在家里的RHLE5.5上安装apache的时候,先用user1用户./configure命令配置,然后才用root用户make && make install,结果apache起来 ...

  8. AngularJs学习笔记-组件间通讯

    组件间通讯 (1)输入属性@Input Tips:子组件属性的改变不会影响到父组件 如下,子组件中stockCode属性发生变化不会引起父组件stock属性的变化 (2)输入属性@Output 子组件 ...

  9. js当中mouseover和mouseout多次触发(非冒泡)

    JS当中,mouseover和mouseout多次触发事件,不光是冒泡会产生,就是不冒泡,在一定条件下 ,也会产生多次触发事件: 例如下面的结构的情况下,我在class="ceng_up f ...

  10. java算法面试题:排序都有哪几种方法?请列举。用JAVA实现一个快速排序。选择冒泡快速集合至少4种方法排序

    package com.swift; import java.util.ArrayList; import java.util.Collections; import java.util.Compar ...