实现调用API接口

API 定义

API(Application Programming Interface,应用程序接口)预先定义的函数,提供应用程序或例程给开发人员调用,开发人员无需访问源码和了解内部机制。

  • API 是一个明确的接口,提供服务;
  • API 可以是一个单独的函数,也可以是类、方法、全局函数、枚举、常量等;
  • API 可以是私有,也可以开源。

API 分类

API 优点

  • 快速扩展,提高效率
  • 解耦:降低程序模块的耦合度

Web API

Web API 一般采用 HTTP 作为底层协议

HTTP 请求包含的内容

API 请求方式

常见的请求方式解释
GET请求服务器获取一个资源
POST请求服务器创建一个新的资源
PUT请求服务器编辑或更新一个已存在的资源
DELETE请求服务器删除一个资源

请求头(Headers)

包含客户端发送请求时间、请求主体大小、身份认证信息等。

请求体(Body)

包含 客户端 希望发给 服务器 的数据。

状态码

调用 API 成功,返还 2xx 的状态码

调用 API 失败,返还 5xx 的状态码,表示服务不可用

返还数据格式

JSON and XML

JSON 数据格式 表示方法

API 简单身份认证

APPCODE
Header 中添加 Authorization 字段:APPCODE + 半角空格 + APPCODE值

API 签名认证(AppKey & AppSecret)

API 调试与调用

API 文档 -> 创建应用 -> 获取授权 -> 调用API

  • 本文作者: Ashin Wang
  • 本文链接: https://ashin.wang/notes-api/
  • 版权声明: 本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!