API 完整形式

API 是应用程序接口的缩写，它是一种通信协议，用于不同应用程序之间的交互。API 完整形式包括以下内容：

请求方法

API 提供了一组请求方法，用于在服务端执行指定的操作。常用的请求方法有：

• GET：获取资源
• POST：创建资源
• PUT：更新资源
• DELETE：删除资源

资源地址

API 请求中还包括资源地址，用于标识需要操作的资源。资源地址通常采用统一资源定位符（URL）格式。

数据格式

API 请求和响应中传输的数据通常采用以下格式之一：

• JSON：一种轻量级的数据交换格式，广泛用于Web应用程序之间的交互
• XML：一种标记语言，广泛应用于Web服务和RPC（远程过程调用）通信中
• FORM 表单：当使用 GET 方法请求数据时，数据以参数的形式附加到 URL 后面；当使用 POST 方法请求数据时，数据通常将作为 body 中的表单数据传递。

授权方式

为了保护 API 安全，通常需要授权才能访问 API。授权方式包括：

• 基本身份验证：通过用户名和密码进行验证
• 令牌验证：提供特定的令牌，表示已授权的客户端身份
• OAuth 或 OpenID 连接：更为复杂的授权协议，提供了更全面的授权和身份验证功能。

完整API实例

以 Github 的 API 为例，它的完整形式如下：

请求方法

Github 的 API 支持多种请求方法，包括 GET、POST、PUT 和 DELETE。

资源地址

Github 的 API 请求地址通常采用以下格式：

https://api.github.com/<资源类型>/<资源ID>

例如：

https://api.github.com/users/octocat

该请求将获取 username 为 octocat 的用户信息。

数据格式

Github API 通常采用 JSON 数据格式进行交互。例如，获取用户信息的响应如下：

{
  "login": "octocat",
  "id": 1,
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "url": "https://api.github.com/users/octocat",
  "html_url": "https://github.com/octocat",
  "type": "User",
  "name": "monalisa octocat",
  "company": "GitHub",
  "blog": "https://github.com/blog",
  "location": "San Francisco",
  "email": "octocat@github.com",
  "bio": "There once was...",
  "public_repos": 2,
  "public_gists": 1,
  "followers": 20,
  "following": 0,
  "created_at": "2008-01-14T04:33:35Z",
  "updated_at": "2008-01-14T04:33:35Z"
}

授权方式

Github API 的授权方式基于 OAuth2 协议。

总结

API 完整形式包括请求方法、资源地址、数据格式和授权方式等要素。掌握这些要素可以帮助开发者更好地设计和调用 API。