漫谈Web API的设计-总结

1. API的概念

Application Programming Interface.应用编程接口，早期开发Win32或者MFC的程序员很是的熟悉。添加Web前缀以后，就变成了Web API。主要先后端开发过程当中，程序交互使用的接口。

2. Web API包含内容

1. 地址
2. 请求方式
3. 请求参数
4. 返回参数
5. 其余

3. Web API的设计步骤

1. 肯定功能需求，根据页面和自己业务逻辑设计相应的接口
2. 选择承载技术。好比目前基于流行的RESTful风格，采用HTTP+JSON的方式居多。
3. 肯定接口风格。有遵循SOAP协议的web service风格，有基于HTTP+JSON的restful风格等。
4. 定义接口形式

4.1 条件查询

/books/123 //查询id为123的图书详情信息
/books/123/price //查询id为123的图像价格
复制代码

4.2 消息正文封装

{
    "name":"xxx",
    "companyId":"1001",
    "age":30,
    "address":{
        "city":"suzhou",
        "road":"kejicehng ..."
    }
}
复制代码

• 传递惟一业务字段，好比name
• 传递惟一id，好比companyId，对于companyName是不须要前端传入，后台应该是有能力根据companyId获取到对应的companyName。
• 传递关联对象。传入数据关联了其余对象数据。

4.3 响应和异常设计

实际开发中，常见响应和异常设计以下：

成功

{
    "message":"ok",
    "success":true,
    "entity":{
        //对象或者数组
    }
}
复制代码

失败

{
    "message":"新建用户失败",
    "success":false,
    "entity":null
}
复制代码

更多

不少使用的API也经过聚合在市场上，经过次数计费。实际开发过程当中，咱们能够直接购买付费的API，快速的开发咱们本身的业务。www.juhe.cn/