🍋
Menu
General

API

API(应用程序编程接口)

一组定义好的规则和协议,允许不同的软件应用程序相互通信,使开发者能够访问服务的功能或数据,而无需了解其内部工作原理。

技术细节

Web API 通常遵循 REST 架构风格,使用 HTTP 方法(GET、POST、PUT、DELETE)和 JSON 有效负载。关键设计原则包括无状态性、基于资源的 URL、合适的 HTTP 状态码和版本控制(URL 路径或头部)。认证方法从 API 密钥和 OAuth 2.0 令牌到 JWT(JSON Web Token)不等。GraphQL 提供了一种替代查询语言,让客户端精确指定所需的数据。速率限制、CORS 头和分页对于生产 API 至关重要。

示例

```javascript
// API: file processing example
const file = document.getElementById('fileInput').files[0];
const reader = new FileReader();
reader.onload = (e) => {
  const data = e.target.result;
  console.log(`Loaded: ${file.name} (${file.size} bytes)`);
};
reader.readAsArrayBuffer(file);
```

相关术语