一:基础简介
(1)接口:
(1)生活中:连接两个物体的媒介
(2)web:连接前段后端的媒介
(2)接口的组成
(1)url:
(2)请求参数:按照后端的要求 前段输入指定的key提交给后端
(3)响应结果:后台与数据库交互数据 传递给前端
二:restfull接口规范
(1)作用:
(1)根据不同的语音环境写同样的接口 后端也能获取数据
(2)接口组成
(1)url
1: 用api关键字标识接口url api.baidu.com | www.baidu.com/api 2):接口数据安全性决定优先选择https协议 3: 如果一个接口有多版本存在,需要在url中标识体现 api.baidu.com/v1/... | api.baidu.com/v2/... 4):接口操作的数据源称之为 资源,在url中一般采用资源复数形式,一个接口可以概括对该资源的多种操作方式 api.baidu.com/books | api.baidu.com/books/(pk) 5: 请求方式有多种,用一个url处理如何保证不混乱 - 通过请求方式标识操作资源的方式 /books get 获取所有 /books post 增加一个(多个) /books/(pk) delete 删除一个 /books/(pk) put 整体更新一个 /books/(pk) patch 局部更新一个 6: 资源往往涉及数据的各种操作方式 - 筛选、排序、限制 api.baidu.com/books/?search=西&ordering=-price&limit=3
(2)响应数据
1: http请求的响应会有响应状态码,接口用来返回操作的资源数据,可以拥有 操作数据结果的 状态码 status 0(操作资源成功) 1(操作资源失败) 2(操作资源成功,但没匹配结果) 注:资源状态码不像http状态码,一般都是后台与前台或是客户约定的 2: 资源的状态码文字提示 status ok '账号有误' '密码有误' '用户锁定' 3: 资源本身 results 注:删除资源成功不做任何数据返回(返回空字符串) 4: 不能直接放回的资源(子资源、图片、视频等资源),返回该资源的url链接
三:基于restful规范的原生接口书写方式
# 主路由 做路由分发 from django.conf.urls import url, include from django.contrib import admin
urlpatterns = [ url(r'^admin/', admin.site.urls), # 路由分发 url(r'^api/', include('api.urls')) ]
# api子组件路由 from django.conf.urls import url from . import views urlpatterns = [ url(r'^books/', views.Book.as_view()), url(r'^books/(?P<pk>.*)/$', views.Book.as_view()), ]
# 模型层 from django.db import models class Book(models.Model): title = models.CharField(max_length=64) price = models.DecimalField(max_digits=5, decimal_places=2) class Meta: db_table = 'old_boy_book' # 数据库重命名 verbose_name = '书籍' # 表格命名 verbose_name_plural = verbose_name # 调用表格 def __str__(self): return '《%s》' % self.title
from . import models # from django.views import View from django.http import JsonResponse class Book(View): def get(self, request, *args, **kwargs): # get请求 primary_key = kwargs.get('primary_key') # 匹配前面有名分组 if not primary_key: # 查询所有 book_obj_list = models.Book.objects.all() print(book_obj_list) # <QuerySet [<Book: <<西游记>>>, <Book: <<红楼梦>>>]> book_list = [] # 序列化开始 for book_obj in book_obj_list: back_dic = {} back_dic['name'] = book_obj.name back_dic['price'] = book_obj.price book_list.append(back_dic) # 序列化结束 # 返回数据给前段 return JsonResponse({ 'status': 0, 'msg': '查询成功', 'results': book_list, }, json_dumps_params={'ensure_ascii': False}) else: # 查询单个 book_dict = models.Book.objects.filter(pk=primary_key).values('name', 'price').first() print(book_dict, type(book_dict)) # <QuerySet [<Book: <<西游记>>>, <Book: <<红楼梦>>>]> if not book_dict: # 判断数据是否存在 return JsonResponse( {'status': 1, 'msg': '该书籍不存在', }, json_dumps_params={'ensure_ascii': False} ) return JsonResponse({ 'status': 1, 'msg': '查询成功', 'result': book_dict }, json_dumps_params={'ensure_ascii': False} ) def post(self, request, *args, **kwargs): # post请求 print(request.POST.dict()) # {'name': '神墓', 'price': '199.99'} recv_dict = request.POST.dict() book_obj = models.Book.objects.create(**recv_dict) # 获取用户输入的值 将对象打散转换成字典形式 if not book_obj: return JsonResponse({ 'status': 1, 'msg': '创建异常' }, json_dumps_params={'ensure_ascii': False}) return JsonResponse({ 'status': 0, 'msg': '添加成功', 'results': {'name': book_obj.name, 'price': book_obj.price} }, json_dumps_params={'ensure_ascii': False})