SOAP API 转换为 REST API

大家好，今天，我将通过代码示例，介绍如何从 SOAP API 转换到 REST API。同时，我也会参考 Swagger 的使用方法和网上的资料，来具体展示实现过程。

一、REST API 的基本概念

REST API 是一种通过 HTTP 方法（如 GET、POST、PUT、DELETE 等）操作资源的 API。它通过 URL 访问资源，并通过 HTTP 方法指定操作。

二、获取令牌

首先，需要在 OpenM 服务器上创建账户并获取令牌。令牌用于 API 的身份验证。

{
  ""username"": ""your_username"",
  ""password"": ""your_password""
}

可以使用以下代码向 API 的认证端点发送这个 JSON 格式的数据，从而获取令牌。

import requests
import json

url = ""https://api.example.com/auth""
data = {
    ""username"": ""your_username"",
    ""password"": ""your_password""
}

response = requests.post(url, json=data)
token = response.json().get(""token"")

三、获取用户列表

获取令牌后，使用它来获取用户列表。将令牌添加到请求头中，并发送 GET 请求。

headers = {
    ""Authorization"": f""Bearer {token}"",
    ""Content-Type"": ""application/json""
}

response = requests.get(""https://api.example.com/users"", headers=headers)
users = response.json()
print(users)

四、获取项目列表

同样地，可以使用以下代码获取项目列表。

response = requests.get(""https://api.example.com/projects"", headers=headers)
projects = response.json()
print(projects)

五、XML 语法

虽然 SOAP API 常用 XML 格式，但 REST API 通常使用 JSON 格式。如果需要从 XML 转换为 JSON，可以按照以下方法进行。

<request>
  <username>your_username</username>
  <password>your_password</password>
</request>

将上述 XML 数据转换为 JSON 格式。

{
  ""username"": ""your_username"",
  ""password"": ""your_password""
}

六、使用方法

在 REST API 中，通过 HTTP 方法（GET、POST、PUT、DELETE）操作资源。例如，要获取用户列表，使用 GET 方法；要创建新用户，使用 POST 方法。

# 创建新用户
new_user = {
    ""username"": ""new_user"",
    ""password"": ""new_password""
}

response = requests.post(""https://api.example.com/users"", headers=headers, json=new_user)
print(response.json())

七、注意事项

• 将令牌添加到头部：身份验证令牌需要以 Authorization: Bearer {token} 的形式添加到头部。
• 指定 Content-Type：在请求头部中指定 Content-Type: application/json。
• 处理响应：响应以 JSON 格式返回，因此可以使用 response.json() 获取数据。

总结

从 SOAP API 转换到 REST API 主要关注 HTTP 方法的使用和数据格式的变更。REST API 使用 JSON 格式发送和接收数据，并通过 HTTP 方法（GET、POST、PUT、DELETE）操作资源。通过获取令牌并将其添加到头部，可以进行身份验证和数据获取。

原文引自YouTube视频：https://www.youtube.com/watch?v=I5gvHmSzfok