目前市面上大部分公司开发人员使用的接口服务架构主要有：restful、rpc。
rpc :远程过程调用[远程服务调用]
post请求 action=get_all_student¶ms=301&sex=1 接口多了,对应函数名和参数就多了,前端在请求api接口时,就会比较难找.容易出现重复的接口
restful: 资源状态转换
把后端所有的数据/文件都看成资源，那么接口请求数据,本质上来说就是对资源的操作了。 web项目中操作资源,无非就是增删查改，所以要求在地址栏中声明要操作的资源是什么，然后通过http请求动词来说明对资源进行哪一种操作。
POST 添加 GET 获取 DELETE 删除RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。 这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。 而对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。
请求方法请求地址后端操作GET/students获取所有学生POST/students增加学生GET/students/<pk>获取编号为pk的学生PUT/students/<pk>修改编号为pk的学生DELETE/students/<pk>删除编号为pk的学生参考文档：http://www.runoob.com/w3cnote/restful-architecture.html
api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段： 序列化： 把我们识别的数据转换成指定的格式提供给别人。 例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人。 反序列化：把别人提供的数据转换/还原成我们需要的格式。 例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。
Django REST framework是一个建立在Django基础之上的Web 应用开发框架，可以快速的开发REST API接口应用。在REST framework中，提供了序列化器Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个API 的Web可视化界面来方便查看测试接口。 中文文档：https://q1mi.github.io/Django-REST-framework-documentation/#django-rest-framework github: https://github.com/encode/django-rest-framework/tree/master 英文文档：https://www.django-rest-framework.org/
DRF需要以下依赖：
Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)Django (1.10, 1.11, 2.0)DRF是以Django扩展应用的方式提供的，可以直接利用已有的Django环境而无需从新创建。（若没有Django环境，需要先创建环境安装Django）
在settings.py的INSTALLED_APPS中添加’rest_framework’。
INSTALLED_APPS = [ ... 'rest_framework', ]接下来就可以使用DRF提供的功能进行api接口开发了。在项目中如果使用rest_framework框架实现API接口，主要有以下三个步骤：
将请求的数据（如JSON格式）转换为模型类对象操作数据库将模型类对象转换为响应的数据（如JSON格式）先创建一个数据库:
create database students charset utf8;执行数据迁移
把students子应用添加到INSTALL_APPS中
初始化数据库连接
安装pymysql pip install pymysql主引用中__init__.py设置使用pymysql作为数据库驱动
import pymysql pymysql.install_as_MySQLdb()settings.py配置文件中设置mysql的账号密码
DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'NAME': "students", "HOST": "127.0.0.1", "PORT": 3306, "USER": "root", "PASSWORD":"123456", } }终端下，执行数据迁移
python manage.py makemigrations python manage.py migrate错误列表
# 执行数据迁移 python manage.py makemigrations 报错：解决方案：
注释掉 python/site-packages/django/backends/mysql/base.py中的35和36行代码。 # if version < (1, 3, 13): # raise ImproperlyConfigured('mysqlclient 1.3.13 or newer is required; you have %s.' % Database.__version__) # 执行数据迁移发生以下错误： query = query.decode(errors='replace') AttributeError: 'str' object has no attribute 'decode'解决方法：
Python36\lib\site-packages\django\db\backends\mysql\operations.py146行里面新增一个行代码： query = query.encode()在django项目中创建学生子应用
python manage.py startapp students在students应用目录中新建serializers.py用于保存该应用的序列化器 创建一个StudentModelSerializer用于序列化与反序列化
# 创建序列化器类，回头会在试图中被调用 class StudentModelSerializer(serializers.ModelSerializer): class Meta: model = Student fields = "__all__" model 指明该序列化器处理的数据字段从模型类Student参考生成fields 指明该序列化器包含模型类中的哪些字段，'all’指明包含所有字段在students应用的views.py中创建视图StudentViewSet，这是一个视图集合
from rest_framework.viewsets import ModelViewSet from .models import Student from .serializers import StudentModelSerializer # Create your views here. class StudentViewSet(ModelViewSet): queryset = Student.objects.all() serializer_class = StudentModelSerializer queryset 指明该视图集在查询数据时使用的查询集serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器在students应用的urls.py中定义路由信息
from . import views from rest_framework.routers import DefaultRouter # 路由列表 urlpatterns = [] router = DefaultRouter() # 可以处理视图的路由器，自动通过视图来生成增删改查的url路径 router.register('students', views.StudentViewSet) #students是生成的url前缀，名称随便写， 向路由器中注册视图集 urlpatterns += router.urls # 将路由器中的所以路由信息追到到django的路由列表中最后把students子应用中的路由文件加载到总路由文件中
from django.contrib import admin from django.urls import path,include urlpatterns = [ path('admin/', admin.site.urls), path("stu/",include("students.urls")), ]在浏览器中输入网址127.0.0.1:8000/stu，可以看到DRF提供的API Web浏览页面：
1 在应用中创建一个py文件,比如叫做serializers.py
from rest_framework import serializers class StudentSerizlizer(serializers.Serializer): name = serializers.CharField() age = serializers.IntegerField() class_null = serializers.CharField() description = serializers.CharField()2 在视图中使用
from django.shortcuts import render,HttpResponse from django.http import JsonResponse from students import models # Create your views here. from django.views import View from .serializers import StudentSerizlizer class StudentView(View): def get(self,request): # all = models.Student.objects.all() #quseryset model one = models.Student.objects.get(id=1) #quseryset model # serializer = StudentSerizlizer(all,many=True) # serializer = StudentSerizlizer(all) #结果为：[{},{}]形式 serializer = StudentSerizlizer(one) #得到的结果为字典 data print(serializer.data) #{'name': 'chao', 'age': 18, 'class_null': '31', 'description': 'xxxxx'} return JsonResponse(serializer.data,safe=False,json_dumps_params={'ensure_ascii':False})3 应用配置文件
INSTALLED_APPS = [ ... 'students.apps.StudentsConfig', 'rest_framework', 'ser' ] DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'NAME': 'drf01', 'HOST':'127.0.0.1', 'PORT':3306, 'USER':'root', 'PASSWORD':'123456' } }1 创建反序列化组件 在应用中创建一个py文件,比如叫做serializers.py
from rest_framework import serializers # 自定义校验函数 def check666(val): if '666' in val: raise serializers.ValidationError('不能光喊6666啊，没有用') else: return val class StudentSerizlizer(serializers.Serializer): name = serializers.CharField(max_length=4,validators=[check666,]) age = serializers.IntegerField(max_value=18) class_null = serializers.CharField() # description = serializers.CharField(required=False,allow_null=True) # required=False,allow_null=True允许字段为空，也就是不用传递过来这个data description = serializers.CharField(allow_blank=True) #allow_blank=True 允许只为空字符串2 视图中使用
class Student(View): def get.. ... def post(self,request): # content-type # if content-type == 'urlencoded': # #username=chao&password=123&a=1 # request.POST['username'] = 'chao' # elif content-type == 'form-data': # # 分片接受数据 # request.FILES # django没有自带解析json数据的解析器，所以需要我们手动的解析，但是drf中已经有了 # content - type == 'application/json' # print(request.POST) data = { 'name':request.POST.get('name'), 'age':request.POST.get('age'), 'class_null':request.POST.get('class_null'), 'description':request.POST.get('description'), } ser = StudentSerizlizer(data=data) print(ser.is_valid()) #校验，全部通过得到True，一个字段错了都是得到False print(ser.errors) #所有字段的错误信息 # print(request.body) return HttpResponse('ok')应该尽量将API部署在专用域名之下
https://api.example.com如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下
https://example.org/api/应该将API的版本号放入URL
http://www.example.com/app/1.0/foo http://www.example.com/app/1.1/foo http://www.example.com/app/2.0/foo另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github就采用了这种做法
因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URL。版本号可以在HTTP请求头信息的Accept字段中进行区分（参见Versioning REST Services）
Accept: vnd.example-com.foo+json; version=1.0 Accept: vnd.example-com.foo+json; version=1.1 Accept: vnd.example-com.foo+json; version=2.0路径又称"终点"（endpoint），表示API的具体网址，每个网址代表一种资源（resource） (1) 资源作为网址，只能有名词，不能有动词，而且所用的名词往往与数据库的表名对应 举例来说，以下是不好的例子:
/getProducts /listOrders /retreiveClientByOrder?orderId=1对于一个简洁结构，你应该始终用名词。 此外，利用的HTTP方法可以分离网址中的资源名称的操作
GET /products ：将返回所有产品清单 POST /products ：将产品新建到集合 GET /products/4 ：将获取产品 4 PATCH（或）PUT /products/4 ：将更新产品 4(2) API中的名词应该使用复数，无论子资源或者所有资源。 举例来说，获取产品的API可以这样定义
获取单个产品：http://127.0.0.1:8080/AppName/rest/products/1 获取所有产品: http://127.0.0.1:8080/AppName/rest/products对于资源的具体操作类型，由HTTP动词表示。 常用的HTTP动词有下面四个（括号里是对应的SQL命令）。
GET(SELECT): 从服务器取出资源（一项或多项）POST(CREATE): 在服务器新建一个资源PUT(UPDATE): 在服务器更新资源（客户端提供改变后的完整资源）DELETE(DELETE): 从服务器删除资源还有三个不常用的HTTP动词。
PATCH(UPDATE): 在服务器更新(更新)资源（客户端提供改变的属性）HEAD: 获取资源的元数据OPTIONS: 获取信息，关于资源的哪些属性是客户端可以改变的下面是一些例子:
GET /zoos：列出所有动物园 POST /zoos：新建一个动物园（上传文件） GET /zoos/ID：获取某个指定动物园的信息 PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息） PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息） DELETE /zoos/ID：删除某个动物园 GET /zoos/ID/animals：列出某个指定动物园的所有动物 DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。 下面是一些常见的参数
?limit=10：指定返回记录的数量 ?offset=10：指定返回记录的开始位置。 ?page=2&per_page=100：指定第几页，以及每页的记录数。 ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。 ?animal_type_id=1：指定筛选条件参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoos/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。
200 OK - [GET]：服务器成功返回用户请求的数据201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）204 NO CONTENT - [DELETE]：用户删除数据成功。400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。状态码的完全列表参见这里或这里。
如果状态码是4xx，服务器就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。
{ error: "Invalid API key" }针对不同操作，服务器向用户返回的结果应该符合以下规范。
GET /collection：返回资源对象的列表（数组）GET /collection/ID：返回单个资源对象(json)POST /collection：返回新生成的资源对象(json)PUT /collection/ID：返回完整的资源对象(json)DELETE /collection/ID：返回一个空文档(空字符串)RESTful API最好做到Hypermedia（即返回结果中提供链接，连向其他API方法），使得用户不查文档，也知道下一步应该做什么。 比如，Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。
{ "current_user_url": "https://api.github.com/user", "authorizations_url": "https://api.github.com/authorizations", // ... }从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果。
{ "message": "Requires authentication", "documentation_url": "https://developer.github.com/v3" }上面代码表示，服务器给出了提示信息，以及文档的网址。
服务器返回的数据格式，应该尽量使用JSON，避免使用XML。
