应用程序编程接口（API） — 简单解释

大家好，欢迎来到IT知识分享网。

文章目录

一、说明
二、API 的类型
二、示例健身应用程序
三、可乐自动售货机
四、客户端和服务器
五、超文本传输协议（HTTP）

图 1：客户端使用其 API 与服务器交互。应用程序编程接口是应用程序的编程接口应用程序编程接口（API）

一、说明

API是应用程序在以编程方式与其他应用程序交互时需要遵循的一组规则。API 代表应用程序编程接口。在 API 上下文中，“应用程序”一词指的是具有独特功能的任何软件。接口可以被认为是两个应用程序之间的服务契约。该合约定义了两者如何使用请求和响应相互通信。

二、API 的类型

允许硬件与软件交互的硬件 API，例如，手机的相机与操作系统交互。

软件 API，允许您从现有软件包或库中调用方法。

允许您通过 Internet 从远程计算机访问资源（数据）或服务（功能）的 Web API。

您可以拥有私有、公共或合作伙伴 API。公共 API 可供任何人使用，合作伙伴 API 仅可供受信任方使用，私有 API 仅限于内部使用。

在本教程中，我们将重点介绍公共 Web API。

二、示例健身应用程序

假设您正在构建一个健身应用程序，并希望显示一张地图，其中突出显示了城市中的所有公园，以便客户可以在其中慢跑。现在，您可以从头开始在您的应用程序中开发此功能，但这不是您应用程序的核心功能，Google 地图专注于此类功能。因此，您将请求 Google 地图应用程序为您提供有关客户城市中公园位置的数据及其创建突出显示这些位置的地图的功能。这样，您就可以专注于健身应用程序的核心功能，同时仍然为您的客户提供额外的功能。

要成功请求 Google Maps 获取所需的数据和所需的功能，您的应用程序必须以 Google Maps API 要求它遵循的特定格式（API 规范）构建请求。

这很像在编程语言中调用函数。您需要根据函数定义的原型构建函数调用，否则会出现错误。

三、可乐自动售货机

有时，自动售货机的类比会有所帮助：

要成功地将产品从机器中取出，您需要以正确的顺序遵循一组正确的步骤。

这个简单的外部界面使客户能够专注于他们需要的自动售货机产品，而不必担心不必要的细节，它允许自动售货机制造商对客户保密他们的内部细节。

Amazon.com

我们都用过 amazon.com。它的核心功能是为您提供多种产品和选择，让您浏览和选择您想要的产品，将它们放入购物车并购买。为了管理支付部分，amazon.com 使用 PayPal 或 UPI 等第三方的功能，如 Google Pay、PayTM。amazon.com 调用这些支付公司的 API，客户在其中输入他们的身份验证信息、付款并被重定向到 amazon.com 以完成购买和跟踪或订单。

四、客户端和服务器

需要服务（功能）或资源（数据）的应用程序（例如，浏览器、python 程序等）称为客户端。提供所需服务或资源的另一个应用程序称为服务器。（见图 1）。例如，您使用 Google Chrome 客户端访问 amazon.com 提供的服务。

要访问服务或资源，客户端需要按照 API 指定的格式构造请求，并使用 HTTP 等协议将其发送到服务器。服务器根据 API 规范以响应进行响应。

五、超文本传输协议（HTTP）

处理从客户端到服务器的请求以及通过 WEB 将包含资源表示形式从服务器传输到客户端的响应的协议是 HTTP（超文本传输协议）。因此，HTTP 是一种请求-响应协议。

API 告诉客户端如何形成其请求，以及当它向服务器的端点发出特定请求/调用时会发生什么类型的响应。

5.1 端点

Endpoint 使用一个公开的 uri（统一资源指示器），服务器在该 uri 上公开它提供的资源。

要访问这些资源，客户端必须将其请求定向到此终端节点。

5.2 API 调用

API 调用是从客户端到服务器的 API 端点的请求。

HTTP 为客户端和服务器交互提供了以下方法：

5.3 HTTP 标头

标头是 HTTP 请求和 HTTP 响应中的附加信息。这些标头可能包含客户端的身份验证凭据、内容类型、响应可以缓存多长时间等信息。如果 HTTP 标头中的控制数据允许压缩信号，则可以在将响应发送到 clinet 之前对其进行 GZIP 压缩。

5.4 有效载荷

Payload 是客户端请求的 HTTP 响应的一部分。它包含所请求资源的表示形式。

突出的 API 架构

REST（再现状态传输）（RESTful API）
GraphQL-
WebSockets
webhook-
SOAP（简单对象访问协议）
gRPC（Google 远程过程调用）
MQTT（MQ 遥测传输）

API 需要遵循以下 REST 原则才能被归类为 RESTful API：

GraphQL 中：是 API 的一种查询语言，通过允许客户端请求特定数据来提供灵活性。

WebSockets 的 URL：是一个 API，可在通信各方之间提供全双工通信通道，从而在客户端和服务器之间实现实时数据交换

Webhook （网络钩子）：服务器向客户端应用程序发送的通知，由特定事件触发。

SOAP （Simple Object Access Protocol）（简单对象访问协议）：用于结构化数据交换的基于 XML 的协议，通常用于企业环境。

gRPC 中：使用 Protocol Buffers 实现高效数据序列化的高性能、与语言无关的框架。

MQTT（MQ 遥测传输）：适用于 IoT 设备和受限环境的轻量级发布-订阅协议。

身份验证说明 — 如何连接 API
2.API 端点
3.终端节点
的可用资源 4.API
5 的 HTTP 请求格式。API 服务器返回
的 HTTP 响应的响应格式 6.响应中包含的响应代码。

5.6 常见 API 状态代码

对于客户端发送到 Web 服务器的每个请求，它都会收到一个状态代码，指示请求发生的情况。与 GET 请求相关的一些常见代码包括：

!pip install requests

import requests

def search_books(query):
    """Searches for books based on a query."""
    url = f"https://www.googleapis.com/books/v1/volumes?q={ 
       query}"
    response = requests.get(url)
    return response.json()

# Example usage
query = "python programming"
results = search_books(query)

# Print the titles of the first few books
for item in results['items']:
    print(item['volumeInfo']['title'])

Output:
Python Programming
Introduction to Python Programming
Learning Python
Taming PYTHON By Programming
Bite-Size Python
LEARN PYTHON WITH 200 PROGRAMS
Python for Kids, 2nd Edition
Python Programming For Beginners
An Introduction to Python Programming: A Practical Approach
Python Tutorial

Postman邮差

Postman 是一个平台，用于构建您自己的 API 并轻松使用其他人提供的 API。

cURL

cURL 是一个命令行工具和库，用于使用 URL 传输数据，即向服务器发出 HTTP 请求和接收响应。

5.8 设计 API 的最佳实践

免责声明：本站所有文章内容,图片，视频等均是来源于用户投稿和互联网及文摘转载整编而成，不代表本站观点，不承担相关法律责任。其著作权各归其原作者或其出版社所有。如发现本站有涉嫌抄袭侵权/违法违规的内容,侵犯到您的权益，请在线联系站长,一经查实,本站将立刻删除。本文来自网络,若有侵权，请联系删除，如若转载，请注明出处：https://haidsoft.com/118825.html

应用程序编程接口 （API） — 简单解释