odoo18开发手册--API数据交互

API与数据交互

定义
- API（Application Programming Interface，应用程序编程接口）是一组定义了软件组件之间如何交互的规则和协议。它允许不同的软件系统之间进行通信和数据交换，而无需了解彼此内部的实现细节。例如，一个社交媒体平台可能提供API，允许第三方开发者创建与该平台交互的应用程序，如在其他网站上显示社交媒体的分享计数或用户资料。
类型
- RESTful API：这是一种基于HTTP协议的API设计风格。它使用HTTP方法（如GET、POST、PUT、DELETE）来对资源进行操作。例如，一个电商网站的RESTful API可能有一个用于获取产品信息的GET请求（如“/products/123”可以获取ID为123的产品的详细信息），以及一个用于创建新订单的POST请求（如“/orders”可以用来提交新的订单数据）。
- SOAP API：简单对象访问协议（Simple Object Access Protocol）API，它是一种基于XML的协议。SOAP API通常在企业级应用中使用，比较注重安全性和事务处理。例如，银行系统之间可能使用SOAP API来进行资金转账等复杂的业务操作，因为它可以在消息中包含详细的安全和事务处理信息。

客户端发起请求
- 当一个应用（客户端）想要与另一个系统（服务器端）进行数据交互时，首先由客户端构建一个API请求。例如，在一个移动天气应用中，客户端可能会向气象数据提供商的API发起一个GET请求，以获取特定地区的天气信息。这个请求通常包含请求的URL（包含API的端点地址和可能的参数）、请求方法（如GET）以及可能的请求头（如包含身份验证信息或指定数据格式的头部）。
请求参数传递
- 在请求中，客户端可能需要传递一些参数来指定要获取或操作的数据。继续以天气应用为例，如果要获取某个城市的天气，可能会在请求中包含城市名称作为参数（如“?city = New York”）。对于POST请求，例如创建用户账户的API请求，请求体中可能包含用户名、密码、电子邮件等用户注册信息的参数。

服务器端接收与验证
- 服务器端接收到客户端的请求后，首先会对请求进行验证。这包括检查请求的合法性，如验证请求方法是否被允许（例如，某个API端点可能只允许GET请求）、请求头是否包含必要的信息（如身份验证令牌是否有效）以及请求参数是否符合要求（如参数的格式、范围是否正确）。
- 如果验证不通过，服务器可能会返回一个错误响应，如400 Bad Request（表示请求格式错误）或401 Unauthorized（表示身份验证失败）。
数据查询与操作
- 如果请求验证通过，服务器端会根据请求的内容进行数据查询或操作。在一个电商API中，如果客户端发起一个获取订单列表的GET请求，服务器端会查询数据库中的订单表，获取与用户相关的订单数据。如果是一个更新产品库存的POST请求，服务器端会对数据库中的库存数据进行更新操作。

构建响应
- 服务器在完成数据查询或操作后，会构建一个响应返回给客户端。响应包括一个状态码（如200 OK表示成功，404 Not Found表示请求的资源不存在）、响应头（如指定响应数据的格式，如Content - Type: application/json表示返回的数据是JSON格式）和响应体（包含实际要返回的数据内容）。
客户端接收与处理
- 客户端接收到服务器的响应后，会根据状态码判断请求是否成功。如果成功，客户端会对响应体中的数据进行处理。例如，在天气应用中，客户端会解析返回的JSON格式的天气数据，然后将温度、天气状况等信息显示在应用的界面上。如果收到错误状态码，客户端可能会向用户显示相应的错误消息，如“无法获取天气信息，请稍后重试”。

JSON（JavaScript Object Notation）
- JSON是一种轻量级的数据交换格式，非常适合在API中使用。它基于JavaScript的对象字面量语法，但可以被多种编程语言使用。例如，一个返回用户信息的API响应可能如下：
```
{
  "id": 123,
  "name": "John Doe",
  "email": "[email protected]"
}
```
- JSON的优点是简洁、易于阅读和解析，并且在网络传输中占用的带宽相对较小。
XML（eXtensible Markup Language）
- XML是一种标记语言，用于在不同系统之间存储和交换数据。虽然在现代API中使用相对较少，但在一些传统的企业级应用和旧系统中仍然存在。例如，一个XML格式的订单数据可能如下：
```
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <id>456</id>
  <customer>
    <name>Jane Smith</name>
    <email>[email protected]</email>
  </customer>
  <products>
    <product>
      <name>Product A</name>
      <quantity>2</quantity>
    </product>
    <product>
      <name>Product B</name>
      <quantity>1</quantity>
    </product>
  </products>
</order>
```
- XML的优点是具有良好的扩展性和结构清晰，但相比于JSON，它的语法较为繁琐，解析也相对复杂。

身份验证
- 为了确保只有授权的客户端能够访问API，通常会采用身份验证机制。常见的身份验证方法包括API密钥（API Key）、OAuth等。API密钥是一个简单的字符串，客户端在请求时需要将其包含在请求头或请求参数中。例如，一个地图API可能要求客户端提供API密钥才能获取地图数据，如“?api_key = 1234567890abcdef”。OAuth则是一种更复杂的授权框架，常用于需要用户授权第三方应用访问其数据的情况，如在社交媒体平台的API中，第三方应用需要通过OAuth获取用户的授权才能访问用户的个人资料等信息。
数据加密
- 在API数据交互过程中，为了保护数据的隐私和完整性，可能会采用数据加密技术。例如，使用SSL/TLS协议对传输的数据进行加密。当客户端向服务器发起请求时，通过SSL/TLS加密通道传输数据，这样即使数据在传输过程中被截获，攻击者也无法读取其中的内容。同时，对于一些敏感数据（如用户密码、支付信息等），在服务器端存储时也可能会采用加密算法进行加密处理，以防止数据泄露。