API接口规范

1. api接口

应用程序编程接口（Application Programming Interface，API接口），就是应用程序对外提供了一个操作数据的入口，这个入口可以是一个函数或类方法，也可以是一个url地址或者一个网络地址。当客户端调用这个入口，应用程序则会执行对应代码操作，给客户端完成相对应的功能。

当然，api接口在工作中是比较常见的开发内容，有时候，我们会调用其他人编写的api接口，有时候，我们也需要提供api接口给其他人操作。由此就会带来一个问题，api接口往往都是一个函数、类方法、或者url或其他网络地址，不管是哪一种，当api接口编写过程中，我们都要考虑一个问题就是这个接口应该怎么编写？接口怎么写的更加容易维护和清晰，这就需要大家在调用或者编写api接口的时候要有一个明确的编写规范！！！

为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们都需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少客户端和服务端双方之间的合作成本。

目前市面上大部分公司开发人员使用的接口实现规范主要有：restful、RPC。

RPC（ Remote Procedure Call ）: 翻译成中文:远程过程调用[远程服务调用]. 从字面上理解就是访问/调用远程服务端提供的api接口。这种接口一般以服务或者过程式代码提供。

服务端提供一个唯一的访问入口地址：http://api.xxx.com/ 或 http://www.xx.com/api
客户端请求服务端的时候，所有的操作都理解为动作，一般web开发时，对应的就是HTTP请求的post请求
通过请求体参数，指定要调用的接口名称和接口所需的参数

action=get_all_student&class=301&sex=1

m=get_all_student&sex=1&age=22

command=100&sex=1&age=22

接口多了,对应函数名和参数就多了,前端在请求api接口时难找.容易出现重复的接口

restful: 翻译成中文: 资源状态转换.(表征性状态转移)

把服务端提供的所有的数据/文件都看成资源，那么通过api接口请求数据的操作，本质上来说就是对资源的操作了.

因此，restful中要求，我们把当前接口对外提供哪种资源进行操作，就把资源的名称写在url地址。
web开发中操作资源，最常见的最通用的无非就是增删查改，所以restful要求在地址栏中声明要操作的资源是什么。然后通过http请求动词来说明对该资源进行哪一种操作.

POST http://www.xxx.com/api/students/ 添加学生数据

GET http://www.xxx.com/api/students/ 获取所有学生

DELETE http://www.xxx.com/api/students/<pk>/ 删除id=pk的一个学生

PUT http://www.xxx.com/api/students/<pk>/ 修改一个学生的全部信息 [id,name,sex,age,]

PATCH http://www.xxx.com/api/students/<pk>/ 修改一个学生的部分信息[age]

也就是说，我们仅需要通过url地址上的资源名称结合HTTP请求动作，就可以说明当前api接口的功能是什么了。

restful是以资源为主的api接口规范，体现在地址上就是资源就是以名词表达。

rpc则以动作为主的api接口规范，体现在接口名称上往往附带操作数据的动作。

2. RESTful API规范

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

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

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

而对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。

GET	/students	获取所有学生
请求方法	请求地址	后端操作
POST	/students	增加学生
GET	/students/<pk>	获取编号为pk的学生
PUT	/students/<pk>	修改编号为pk的学生
DELETE	/students/<pk>	删除编号为pk的学生

restful规范是一种通用的规范，不限制语言和开发框架的使用。事实上，我们可以使用任何一门语言，任何一个框架都可以实现符合restful规范的API接口。

参考文档：http://www.runoob.com/w3cnote/restful-architecture.html

幂等性

接口实现过程中，会存在幂等性。所谓幂等性是指代客户端发起多次同样请求时，是否对于服务端里面的资源产生不同结果。如果多次请求，服务端结果还是一样，则属于幂等接口，如果多次请求，服务端产生结果是不一样的，则属于非幂等接口。

请求方式	是否幂等	是否安全
GET	幂等	安全
POST	不幂等	不安全
PUT/PATCH	幂等	不安全
DELETE	幂等	不安全

- 接口规范

1. 域名

应该尽量将API部署在专用域名之下。

https://api.example.com

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

https://www.example.org/api/

2. 版本（Versioning）

应该将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

3. 路径（Endpoint）

路径又称"终点"（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

3. HTTP动词

对于资源的具体操作类型，由HTTP动词表示。

常用的HTTP动词有下面四个（括号里是对应的SQL命令）。

GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
DELETE（DELETE）：从服务器删除资源。

CURD  Create、Update、Read、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：删除某个指定动物园的指定动物

4. 过滤信息（Filtering）

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

下面是一些常见的参数。query_string 查询字符串,地址栏后面问号后面的数据,格式: name=xx&sss=xxx

完整的URL地址格式：
协议://域名(IP):端口号/路径?查询字符串#锚点
http://www.baidu.com:8080/students?student=1&top=3#bottom
https://www.baidu.com:443/student?student=1&top=3
ws://www.baidu.com:80/student

?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 的含义是相同的。

6. 状态码（Status Codes）

1xx 表示当前本次请求还是持续，没结束
2xx 表示当前本次请求成功
3xx 表示当前本次请求成功，但是服务器进行代理操作/重定向
4xx 表示当前本次请求失败，主要是客户端发生了错误
5xx 表示当前本次请求失败，主要是服务器发生了错误

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

101 Switching Protocols - [*] 协议进行中，一般在http升级到websocket协议的时候就看到

200 OK - [GET]：服务器成功返回用户请求的数据

201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。

202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）

204 NO CONTENT - [DELETE]：用户删除数据成功。

301 Moved Permanently - [*]: 永久重定向

302 Move Temporarily - [*]: 临时重定向

304 Not Modified - [*]: 命中缓存

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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

507 Insufficient Storage [POST/PUT/PATCH] 数据存储出错，往往数据库操作错误出错，服务器就返回这个

状态码的完全列表参见这里或这里。

7. 错误处理（Error handling）

如果状态码是4xx或者5xx，服务器就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。一般格式都是json格式。

{
    error: "Invalid API key"
}

8. 返回结果

restful针对不同操作，服务器向用户返回的结果应该符合以下规范。

GET /collection：返回资源对象的列表（数组）
GET /collection/ID：返回单个资源对象或字典(json)
POST /collection：返回新生成的资源对象(json)
PUT /collection/ID：返回完整的资源对象(json)
DELETE /collection/ID：返回一个空文档(空字符串，空字典)

9. 超媒体（Hypermedia API）

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"
}

上面代码表示，服务器给出了提示信息，以及文档的网址。

10. 其他

服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

XML（eXtend Markup Language，可扩展标记语言）是W3C为了替换HTML研发出来的，但是现在很明显失败了。

语法：

1. xml常用场景：配置文件 微信开发  小程序  安卓

2. xml就是网页文档，文件以 .xml结尾

3. xml文档必须以文档声明开头，所有的xml文档内容都必须写在自定义的根标签内，xml文档有且只有1个根标签。
<xml version="1.0" charset="utf-8">
<根标签>
    ..... xml文档内容
</根标签>

4. xml里面也是由标签组成页面的。标签分单标签和双标签。其中，
   单标签写法： <标签名/>
   双标签写法： <标签名></标签名>

5. xml标签名除了文档声明，其他标签名全部是开发人员自己自定义的。

6. 标签有0个或多个属性，属性必须有属性值。而且属性值必须使用引号圈起来。
<标签名 属性名="属性值" .../>
<标签名 属性名="属性值" ...>标签内容</标签名>

文档举例：

<?xml version="1.0" encoding="utf-8" ?>
<student-list>
<!-- 	<student>
	   <name>小红</name>
	   <age>17</age>
	   <sex>女</sex>
	   <class>301</class>
	</student>
	<student>
	   <name>小红</name>
	   <age>17</age>
	   <sex>女</sex>
	   <class>301</class>
	</student> -->
	<student age="17" sex="男" class="301">小明</student>
	<student age="17" sex="男" class="301">小明</student>
	<student age="17" sex="男" class="301">小明</student>
	<student age="17" sex="男" class="301">小明</student>
	<student age="17" sex="男" class="301">小明</student>
</student-list>

json是目前市面上最流行的数据传输格式。JavaScript Object Notation js对象表示法

语法：

# 1. json文件以 .json结尾，一个json文件中只能保存一个json对象或者一个json数组
# 2. json中的属性类型：
  数组    []                       # python->列表
  对象    {}                       # python->字典
  数值    整型，浮点型，布尔值   
  字符串  双引号圈起来的文本内容
  mull    空

# 3. 数组和对象的成员之间必须以英文逗号隔开，并且最后一个子成员后面不能出现逗号
# 4. json对象只能有属性不能出现方法，而且属性名必须以字符串格式来编写

举例1：

{
    "name": "张三",
    "sex": true,
    "age": 38,
    "money": 88.5,
    "child":{
        "name": "张思",
        "sex": false,
        "age": 4
    },
    "lve":["code","TV","swimming"]
}

举例2：

[
    {
        "name":"小明",
        "sex":true,
    },{
        "name":"小灰",
        "sex":true,
    }
]

使用xml和json表述一本书的内容信息，书的字段：

name varchar

price float

author varchar

pub_data date

word_total int

xml

<?xml version="1.0" encoding="utf-8" ?>
<book>
	<name>金花瓶</name>
	<price>9999</price>
	<author>内容~~~适合多看</author>
	<pub_data>2020-9-8</pub_data>
	<word_total>999</word_total>
</book>

json

{
	"name":"三国演义",
	"price":1,
	"author":"诸葛亮草船借箭。。。",
	"pub_data":"2000-1-1",
	"word_total":50
}

http://www.xx.com:80/students?username=xiaoming&pwd=123

协议名://域名:端口/路径?查询字符串

课外补充：

1. python关于操作xml：  lxml
2. python关于操作json： json, ujson, orjson

posted @ 2021-12-11 09:02 urls 阅读(3850) 评论(0) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部

urls

从来没有什么捷径,唯有脚踏实地的努力和坚持