API 開發(fā)入門指南

本指南將幫助您了解如何使用 AWS CLI、TypeScript、Java 和 Python 調(diào)用 API，以便開始使用 IMDb API 進(jìn)行數(shù)據(jù)查詢。

先決條件

在開始之前，請確保您具備以下條件：

1. AWS 賬戶：您需要一個(gè)有效的 AWS 賬戶。
2. API 訪問權(quán)限：按照 獲取 API 訪問權(quán)限 頁面上的說明獲取您的 API 密鑰和相關(guān) ID。
3. 安裝必要工具：

• AWS CLI：確保在您的計(jì)算機(jī)上安裝并配置 AWS CLI。
• Node.js：用于運(yùn)行 TypeScript 示例。
• Java JDK 8+：用于運(yùn)行 Java 示例。
• Python：確保安裝了 Python 和 boto3 庫。

通過 AWS CLI 調(diào)用 API

示例命令 1：獲取《泰坦尼克號》（1997）IMDb 評分和投票數(shù)

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）標(biāo)題、IMDb 評分、投票數(shù)和前 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 調(diào)用 API

1. 準(zhǔn)備信息：

• AWS 訪問密鑰 ID
• AWS 秘密訪問密鑰
• AWS 數(shù)據(jù)交換數(shù)據(jù)集 ID
• AWS 數(shù)據(jù)交換修訂 ID
• AWS 數(shù)據(jù)交換資產(chǎn) ID
• IMDb API 密鑰

2. 創(chuàng)建請求：

• 方法：POST
• 請求 URL：https://api-fulfill.dataexchange.us-east-1.amazonaws.com/v1
• 授權(quán)：選擇 AWS 簽名
• 添加請求頭：

• Content-Type: application/json
• x-amzn-dataexchange-data-set-id: 您的數(shù)據(jù)集 ID
• x-amzn-dataexchange-revision-id: 您的修訂 ID
• x-amzn-dataexchange-asset-id: 您的資產(chǎn) ID
• x-api-key: 您的 IMDb API 密鑰

3. 請求體：選擇 GraphQL，并粘貼您的查詢。

使用 TypeScript 進(jìn)行 API 查詢

創(chuàng)建 TypeScript 項(xiàng)目

1. 初始化項(xiàng)目：

npm init -y

2. 安裝所需的包：

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

3. 創(chuàng)建查詢文件 titanicRatingsQuery.graphql，并添加查詢內(nèi)容。
4. 創(chuàng)建 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. 運(yùn)行腳本：

npx ts-node imdb_api_request.ts

使用 Java 進(jìn)行 API 查詢

創(chuàng)建 Maven 項(xiàng)目

1. 創(chuàng)建 Maven 項(xiàng)目：

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 的內(nèi)容，使用前述的 Java 示例代碼。
4. 運(yùn)行 Maven 命令編譯并運(yùn)行項(xiàng)目：

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

使用 Python 進(jìn)行 API 查詢

創(chuàng)建 Python 腳本

1. 安裝 boto3：

pip install boto3

2. 創(chuàng)建 titanicRatingsQuery.graphql 文件并添加查詢內(nèi)容。
3. 創(chuàng)建 imdb_api_request.py 文件并添加以下代碼：

import json
import boto3

# 實(shí)例化 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,
    },
)

# 打印響應(yīng)
print("Response Body:", response)

4. 運(yùn)行腳本：

python imdb_api_request.py

結(jié)論

以上是使用 AWS CLI、Postman、TypeScript、Java 和 Python 調(diào)用 IMDb API 的基本指南。確保您根據(jù)自己的需求替換相應(yīng)的 ID 和 API 密鑰，并遵循最佳實(shí)踐以保護(hù)您的憑證。通過這些示例，您可以開始進(jìn)行 API 查詢，并根據(jù)需要構(gòu)建更復(fù)雜的請求。