RESTful格式规范

RESTful是接口开发格式里面很重要的一个山头，基本开发接口都需要遵守这个规范，它共有十条规范格式：
1、域名，一般将api放在组域名下
http://www.example.com/api/

2、版本，一般把接口的版本号放在url中
http://www.example.com/app/1.0/info
http://www.example.com/app/1.2/info

3、路径，路径表示api的具体网址，网址代表一种资源，网址中不能使用动词，只能使用名词，而其必须是复数

#获取单个商品
http://www.example.com/app/goods/1

#获取所有商品
http://www.example.com/app/goods

 

4、使用标准的Http方法，由HTTP动词组成

GET     SELECT ：从服务器获取资源。
POST    CREATE ：在服务器新建资源。
PUT     UPDATE ：在服务器更新资源。
DELETE  DELETE ：从服务器删除资源。

    1
    2
    3
    4

5、过滤信息，如果资源数据较多，服务器不能将所有数据一次全部返回给客户端。API应该提供参数，过滤返回结果

#指定返回数据的数量

http://www.example.com/goods?limit=10
#指定返回数据的开始位置

http://www.example.com/goods?offset=10
#指定第几页，以及每页数据的数量

http://www.example.com/goods?page=2&per_page=20

6、状态码

7、错误信息，一般来说，服务器返回的错误信息，以键值对的形式返回。

8、响应结果

#返回商品列表

GET    http://www.example.com/goods

#返回单个商品

GET    http://www.example.com/goods/cup

#返回新生成的商品

POST   http://www.example.com/goods

#返回一个空文档

DELETE http://www.example.com/goods

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15

9、使用链接链接相关资源，在返回响应结果时提供链接其他API的方法，使客户端很方便的获取相关联的信息。

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