api接口

1.web开发模式

web开发模式主要有两种

1.1 前后端混合开发（前后端不分离）：也就是一个人同时完成前端代码和后端逻辑的书写，这种开发模式的好处是可以使用后端框架提供的模板语法较为简单的完成网页的搭建

1.2 前后端不分离 ：后端人员专注于写后端的接口，返回json，xml格式的数据

# xml格式
<xml>
<name>lqz</name>
</xml>
# json
{"name":"lqz"}

2.api接口

2.1 api接口 ：通过网络，规定了前后台信息交互规则url链接，也就是前后台信息交互的媒介，比如：

#百度地图的api接口 https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml

3.postman

3.1 postman : 一款目前最好用的，模拟发送http请求的工具

3.2 postman的安装https://www.postman.com/进入官网点下载（图示的是windows平台）

安装完成后会得到一个安装包，双击后会自动下载

3.3 postman的使用

4.Restful规范

4.1 restful ：REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。

RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。

这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。

事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。

4.2 restful的十条规范

1  数据的安全保障：url链接一般都采用https协议进行传输 注：采用https协议，可以提高数据交互过程中的安全性<br>
2 接口特征表现，一看就知道是个api接口
	- 用api关键字标识接口url：
	  - [https://api.baidu.com](https://api.baidu.com/)
	  - https://www.baidu.com/api
	  注：看到api字眼，就代表该请求url链接是完成前后台数据交互的

3 多数据版本共存
	- 在url链接中标识数据版本
	- https://api.baidu.com/v1
	- https://api.baidu.com/v2
	注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）
4 数据即是资源，均使用名词（可复数）
	- 接口一般都是完成前后台数据的交互，交互的数据我们称之为资源
	  - https://api.baidu.com/users
	  - https://api.baidu.com/books
	  - https://api.baidu.com/book

注：一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user
 特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义

 https://api.baidu.com/place/search
 https://api.baidu.com/login
5 资源操作由请求方式决定（method）
	- 操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作
	  - https://api.baidu.com/books - get请求：获取所有书
	  - https://api.baidu.com/books/1 - get请求：获取主键为1的书
	  - https://api.baidu.com/books - post请求：新增一本书书
	  - https://api.baidu.com/books/1 - put请求：整体修改主键为1的书
	  - https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书
	  - https://api.baidu.com/books/1 - delete请求：删除主键为1的书
6 过滤，通过在url上传参的形式传递搜索条件
	- https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
	- https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
	- https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
	- https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
	- https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

7 响应状态码
   7.1 正常响应
	- 响应状态码2xx
	  - 200：常规请求
	  - 201：创建成功
   7.2 重定向响应
	- 响应状态码3xx
	  - 301：永久重定向
	  - 302：暂时重定向
   7.3 客户端异常
	- 响应状态码4xx
	  - 403：请求无权限
	  - 404：请求路径不存在
	  - 405：请求方法不存在
	7.4 服务器异常
	- 响应状态码5xx
	  - 500：服务器异常
 8 错误处理，应返回错误信息，error当做key
	{
		error: "无权限操作"
	}

 9 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范
	GET /collection：返回资源对象的列表（数组）
	GET /collection/resource：返回单个资源对象
	POST /collection：返回新生成的资源对象
	PUT /collection/resource：返回完整的资源对象
	PATCH /collection/resource：返回完整的资源对象
	DELETE /collection/resource：返回一个空文档

 10 需要url请求的资源需要访问资源的请求链接
	 # Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么
		{
			"status": 0,
			"msg": "ok",
			"results":[
				{
					"name":"肯德基(罗餐厅)",
					"img": "https://image.baidu.com/kfc/001.png"
				}
				...
				]
		}

4.3 在django中api的设计

4.3.1 drf的安装： pip install djangorestframework (要注意django版本兼容)

4.3.2 使用 ：

1 在setting.py 的app中注册
		INSTALLED_APPS = [
		'rest_framework'
		]
	2 在models.py中写表模型
		class Book(models.Model):
			nid=models.AutoField(primary_key=True)
			name=models.CharField(max_length=32)
			price=models.DecimalField(max_digits=5,decimal_places=2)
			author=models.CharField(max_length=32)
	3 新建一个序列化类
		from rest_framework.serializers import ModelSerializer
		from app01.models import  Book
		class BookModelSerializer(ModelSerializer):
			class Meta:
				model = Book
				fields = "__all__"
	4 在视图中写视图类
		from rest_framework.viewsets import ModelViewSet
		from .models import Book
		from .ser import BookModelSerializer
		class BooksViewSet(ModelViewSet):
			queryset = Book.objects.all()
			serializer_class = BookModelSerializer
	5 写路由关系
		from app01 import views
		from rest_framework.routers import DefaultRouter
		router = DefaultRouter()  # 可以处理视图的路由器
		router.register('book', views.BooksViewSet)  # 向路由器中注册视图集
		  # 将路由器中的所以路由信息追到到django的路由列表中
		urlpatterns = [
			path('admin/', admin.site.urls),
		]
		#这是什么意思？两个列表相加
		# router.urls  列表
		urlpatterns += router.urls

	6 启动，在postman中测试即可

5 自动生成接口文档

1 安装：pip install coreapi

2 在路由中配置
from rest_framework.documentation import include_docs_urls
urlpatterns = [
    ...
    path('docs/', include_docs_urls(title='站点页面标题'))
]
3 视图类：自动接口文档能生成的是继承自APIView及其子类的视图。
-1 ） 单一方法的视图，可直接使用类视图的文档字符串，如
    class BookListView(generics.ListAPIView):
        """
        返回所有图书信息.
        """
-2)包含多个方法的视图，在类视图的文档字符串中，分开方法定义，如
    class BookListCreateView(generics.ListCreateAPIView):
        """
        get:
        返回所有图书信息.
        post:
        新建图书.
        """
-3)对于视图集ViewSet，仍在类视图的文档字符串中封开定义，但是应使用action名称区分，如
    class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    """
    list:
    返回图书列表数据
    retrieve:
    返回图书详情数据
    latest:
    返回最新的图书数据
    read:
    修改图书的阅读量
    """
	
	
如果在启动过程中报错
AttributeError: 'AutoSchema' object has no attribute 'get_link'
解决方法，在设置中配置
REST_FRAMEWORK={'DEFAULT_SCHEMA_CLASS':'rest_framework.schemas.coreapi.AutoSchema'}