API 开发入门指南

本指南将帮助您了解如何使用 AWS CLI、TypeScript、Java 和 Python 调用 API，以便开始使用 IMDb API 进行数据查询。

先决条件

在开始之前，请确保您具备以下条件：

1. AWS 账户：您需要一个有效的 AWS 账户。
2. API 访问权限：按照 获取 API 访问权限 页面上的说明获取您的 API 密钥和相关 ID。
3. 安装必要工具：

• AWS CLI：确保在您的计算机上安装并配置 AWS CLI。
• Node.js：用于运行 TypeScript 示例。
• Java JDK 8+：用于运行 Java 示例。
• Python：确保安装了 Python 和 boto3 库。

通过 AWS CLI 调用 API

示例命令 1：获取《泰坦尼克号》（1997）IMDb 评分和投票数

aws dataexchange send-api-asset \
--data-set-id <Put your Dataset ID here> \
--revision-id <Put your Revision ID here> \
--asset-id <Put your Asset ID here> \
--request-headers "{ \"x-api-key\": \"your-api-key-here\"}" \
--region us-east-1 \
--body "{ \"query\": \"{ title(id: \\\"tt0120338\\\") { ratingsSummary { aggregateRating voteCount } } }\" }"

示例命令 2：获取《黑客帝国》（1999）标题、IMDb 评分、投票数和前 10 名演员

aws dataexchange send-api-asset \
--data-set-id <Put your Dataset ID here> \
--revision-id <Put your Revision ID here> \
--asset-id <Put your Asset ID here> \
--request-headers "{ \"x-api-key\": \"your-api-key-here\"}" \
--region us-east-1 \
--body "{\"query\": \"{ title(id: \\\"tt0133093\\\") { titleText { text } ratingsSummary { aggregateRating voteCount } credits(first: 10) { edges { node { ... on Cast { name { nameText { text } } } } } } } }\"}"

通过 Postman 调用 API

1. 准备信息：

• AWS 访问密钥 ID
• AWS 秘密访问密钥
• AWS 数据交换数据集 ID
• AWS 数据交换修订 ID
• AWS 数据交换资产 ID
• IMDb API 密钥

2. 创建请求：

• 方法：POST
• 请求 URL：https://api-fulfill.dataexchange.us-east-1.amazonaws.com/v1
• 授权：选择 AWS 签名
• 添加请求头：

• Content-Type: application/json
• x-amzn-dataexchange-data-set-id: 您的数据集 ID
• x-amzn-dataexchange-revision-id: 您的修订 ID
• x-amzn-dataexchange-asset-id: 您的资产 ID
• x-api-key: 您的 IMDb API 密钥

3. 请求体：选择 GraphQL，并粘贴您的查询。

使用 TypeScript 进行 API 查询

创建 TypeScript 项目

1. 初始化项目：

npm init -y

2. 安装所需的包：

npm install --save @aws-sdk/client-dataexchange
npm install --save-dev @types/node ts-node typescript

3. 创建查询文件 titanicRatingsQuery.graphql，并添加查询内容。
4. 创建 imdb_api_request.ts 文件并添加以下代码：

import { DataExchangeClient } from "@aws-sdk/client-dataexchange";
import { readFileSync } from "fs";

// 替换以下值
const assetId = "<Put your Asset ID here>";
const datasetId = "<Put your Dataset ID here>";
const revisionId = "<Put your Revision ID here>";
const apiKey = "<Put your API Key here>";

const method = "POST";
const path = "/v1";
const titanicRatingsQuery = readFileSync("./titanicRatingsQuery.graphql", "utf-8");
const body = JSON.stringify({ query: titanicRatingsQuery });

const dataExchangeClient = new DataExchangeClient();

(async () => {
    const response = await dataExchangeClient.sendApiAsset({
        DataSetId: datasetId,
        RevisionId: revisionId,
        AssetId: assetId,
        Method: method,
        Path: path,
        Body: body,
        RequestHeaders: {
            "x-api-key": apiKey,
        },
    });
    console.log("Response Body:", response);
})();

5. 运行脚本：

npx ts-node imdb_api_request.ts

使用 Java 进行 API 查询

创建 Maven 项目

1. 创建 Maven 项目：

mvn archetype:generate -DgroupId=org.AccessingImdbApiExample -DartifactId=imdb-api -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

2. 在 pom.xml 中添加 AWS SDK 的依赖。
3. 替换 src/main/java/org/AccessingImdbApiExample/App.java 的内容，使用前述的 Java 示例代码。
4. 运行 Maven 命令编译并运行项目：

mvn install clean
mvn package
java -jar target/imdb-api-1.0-SNAPSHOT.jar

使用 Python 进行 API 查询

创建 Python 脚本

1. 安装 boto3：

pip install boto3

2. 创建 titanicRatingsQuery.graphql 文件并添加查询内容。
3. 创建 imdb_api_request.py 文件并添加以下代码：

import json
import boto3

# 实例化 DataExchange 客户端
client = boto3.client('dataexchange', region_name='us-east-1')

# 替换以下值
data_set_id = '<Put your Dataset ID here>'
revision_id = '<Put your Revision ID here>'
asset_id = '<Put your Asset ID here>'
api_key = '<Put your API Key here>'

# 读取查询
with open("titanicRatingsQuery.graphql", "r") as query_file:
    query = query_file.read()

body = json.dumps({"query": query})
method = 'POST'
path = '/v1'

response = client.send_api_asset(
    DataSetId=data_set_id,
    RevisionId=revision_id,
    AssetId=asset_id,
    Method=method,
    Path=path,
    Body=body,
    RequestHeaders={
        "x-api-key": api_key,
    },
)

# 打印响应
print("Response Body:", response)

4. 运行脚本：

python imdb_api_request.py

结论

以上是使用 AWS CLI、Postman、TypeScript、Java 和 Python 调用 IMDb API 的基本指南。确保您根据自己的需求替换相应的 ID 和 API 密钥，并遵循最佳实践以保护您的凭证。通过这些示例，您可以开始进行 API 查询，并根据需要构建更复杂的请求。