Web API 接口

接口

接口概念:前台与后台进行信息交互的媒介 - url链接

接口组成:

  • url 链接 - 长得像返回数据的url链接
  • 请求方式 - get(查)、post(增)、put(整体改)、patch(局部改)、delete(删)
  • 请求参数 - 拼接参数、数据包参数(urlencoded、form-data、json)
  • 响应结果 - 响应的 json 或者 xlm 数据



开发阶段接口测试工具

Postman



接口文档

  1. 为什么要写接口文档?

    • 为什么要写接口:作为后台开发者,要将后台数据通过 url 链接反馈给前台
    • 为什么要写文档:作为后台开发者,一定知道该 url 链接应该采用什么请求方式、提交哪些数据、返回了哪些结果
    • 就像后台要将 url 链接前台一样,前台知道应该访问什么链接,所以前台也应该知道采用什么请求方式,以及提交什么数据。
  2. 编写文档

    • 采用 word 编写
    • drf 框架有插件,可以根据 CBV 的类快速生成文档
    • 采用文档的平台
  3. 书写过程

    • 先安装开发需要,完成接口的开发(设置后台url链接,设置请求方式、请求数据、响应结果)

    • 选择一个接口平台,将后台url链接,设置请求方式、请求数据、响应结果信息变成成文档即可


Restful 接口规范

  1. 为什么要指定接口规范?

    在前后台分离情况下,后台可以采用不同的语言运用,开发出类似的功能,所以前后台请求响应的规则是一致的;

    如果按照一套标准来编写接口,后台不管是什么语言,前台都可以采用一样的方式进行交互。

    反过来,后台也不需要管前台到底采用何种方式请求(页面、工具、代码)

  2. 通用的接口规范:Restful 接口规范 - 规定了url如何编写;请求方式的含义;响应的数据规则

    1. url 编写

      https协议 - 保证数据安全性

      api字眼 - 标识操作的是数据

      v1、v2字眼 - 数据的不同版本共存

      资源复数 - 请求的数据称之为资源

      拼接条件 - 过滤群查接口数据(https://api.baidu.com/books/?limit=3&ordering=-price

    2. 请求方式

      /books/ - get - 群查

      /books/(pk)/ - get - 单查

      /books/ - post - 单增

      /books/(pk)/ - put - 单整体改

      /books/(pk)/ - patch - 单局部改

      /books/(pk)/ - delete - 单删

    3. 响应结果

      网络状态码与状态信息:2xx | 3xx | 4xx | 5xx

      数据状态码:前后台约定规则 - 0:成功 1:失败 2:成功无结果

      数据状态信息:自定义成功失败的信息解释(英文)

      数据本体:json数据

      数据子资源:头像、视频等,用资源的url链接


猜你喜欢

转载自www.cnblogs.com/kai-/p/12323928.html