PythonとJavaScriptを使用してAPIをテストする方法

これは、アプリケーションプログラミングインターフェイス（API）を選択することと、それを使用できるかどうかを決定することの間の細い線です。ほとんどのRESTAPIには汎用アーキテクチャがあり、共通のリクエストパスをスレッド化します。しかし、そこにあるいくつかのAPIは標準から逸脱しています。その結果、それらは使いにくくなります。

したがって、APIでソフトウェア全体を構築する前に、品質チェックを実行して、正常に機能していることを確認する必要があります。では、APIテストとは何ですか？APIをどのようにテストできますか？

APIテストとは何ですか？

APIテストでは、APIの機能、セキュリティ、スケーラビリティ、速度などを初期評価して、APIを使用するプログラムに最適かどうかを確認します。ただし、表面的には、さまざまなエンドポイントを介して要求を行ったときに適切な応答を送信するかどうかを確認するためのテストが必要になる場合があります。

その構造に応じて、APIのテスト中に、関連するエンドポイントにリクエスト（Get、Post、Update、またはDelete）を行います。APIテスト中にチェックする多くのメトリックがあります。ただし、初心者レベルでは、ステータスコードからAPIの整合性を検証し、正しいデータをフェッチして受け入れることを確認する必要があります。

そのために、他のWebリクエストと同様に、APIは200、400、500のステータスコードなどを返す場合があります。

ほとんどのAPIは、JSON応答を使用してペイロードを提供します。目標に応じて、他の人はXML、マルチパート、またはHTMLペイロードを受け入れて応答する場合があります。

PythonとJavaScriptを使用してAPIをテストする方法

インターネット上には多くのグラフィカルユーザーインターフェイス（GUI）APIテストツールがありますが、記述されたスクリプトを使用してAPIをより批判的に評価できます。

APIは、ドキュメントで許可するリクエストの種類を通知し、関連するエンドポイントを提供します。したがって、適切なリクエストメソッドを使用してそれらを取得してテストできます。

関連：REST APIとは何ですか？アプリやウェブサイトのデータを取得するにはどうすればよいですか？

実際の本番フェーズとは異なり、APIテストは大雑把です。そのため、本番用のAPIを実行するときほど具体性は必要ありません。APIテストにはさまざまな種類がありますが、この記事では応答検証テストに焦点を当てます。

このチュートリアルでは、JavaScriptのフェッチライブラリとPythonのリクエストライブラリを使用して、偽のストアAPIをテストします。これを行いながら、データの取得、投稿、更新、削除のエンドポイントをテストします。

JavaScriptを使用してGetAPIエンドポイントをテストする方法

本番環境で使用するのと同じように、Axiosまたはfetchメソッドのいずれかを使用してJavaScriptでAPIをテストできます。

fetchを使用してAPIから応答ステータスを取得するには：

fetch('https://fakestoreapi.com/products', ).then(res =>{ console.log(res) })

上記のリクエストは、有効なレスポンスの場合、200ステータスを返します。リクエストが成功すると、APIからリアルタイムデータをリクエストできます。

このAPIからデータを取得しましょう：

fetch('https://fakestoreapi.com/products', ).then(res =>{ if (res.ok){ return res.json() } }).then(response=>{ console.log(response) }).catch(err => console.log(err))

上記のフェッチコードへの応答は次のようになります。

たとえば、すべての製品の価格を取得するには、マップ関数を使用できます。

fetch('https://fakestoreapi.com/products', ).then(res =>{ if (res.ok){ return res.json() } }).then(response=>{ response.map(data =>{ console.log(data.price) }) // console.log(response) }).catch(err => console.log(err))

上記は、次の出力をログに記録します。

PythonでGetEndpointをテストする

前述のように、Pythonはリクエストライブラリを使用してAPIのデータにアクセスします。

この場合の応答のステータスを確認するには、次のようにします。

import requests data = requests.get('https://fakestoreapi.com/products') print(data.status_code)

上記のようにデータをログに記録すると、対応するステータスが返されます。ただし、この場合は200です。

それでは、JavaScriptを使用しているときに行ったのと同じデータをPythonで取得しましょう。

import requests data = requests.get('https://fakestoreapi.com/products') myData = data.json() print(myData)

上記の結果は次のようになります。

forループを使用して特定のデータを取得できます。

たとえば、製品の価格を取得するには、次のようにします。

import requests data = requests.get('https://fakestoreapi.com/products') myData = data.json() indexes = 0 for i in myData: goods = myData[indexes] indexes +=1 print(goods["price"])

出力は次のようになります。

JavaScriptを使用したポストエンドポイントのテスト

Getリクエストが機能することをテストして確認した後、目的とAPIが提供するものに応じて、データを挿入できるかどうかも確認することをお勧めします。

Getリクエストの作成方法とは対照的に、Postリクエストはペイロードを受け入れます。さらに、それがPostリクエストであることを指定する必要があります。

// Specify the payload let payload = { title: 'new product', price: 13.5, description: 'test description', image: '', category: 'electronic' } fetch('https://fakestoreapi.com/products', { method: "Post", headers:{ 'Content-Type': 'application/json' }, body: JSON.stringify(payload) //convert the payload to JSON } ).then(res =>{ if (res.ok){ console.log(res.status) return res.json() } }).then(response => { console.log(response) }).catch(err => console.log(err))

上記のコードは、応答ステータスコードと、実行時に挿入された新しい情報をログに記録します。これにより、リクエストが通過したかどうかがわかります。通常、ステータスコードが200の場合、APIには適切な応答を返す有効なエンドポイントがあります。

Pythonを使用したPOSTリクエストのテスト

Pythonのrequests.postを使用して、APIのポストエンドポイントをテストすることもできます。JavaScriptのフェッチを使用しているときに行ったように、ここでもペイロードを指定する必要があります。

import requests payload = { 'title': 'new product', 'price': 13.5, 'description': 'test description', 'image': '', 'category': 'electronic' } Posted = requests.post('https://fakestoreapi.com/products', data = payload ) print(Posted.status_code) print(Posted.json())

JavaScriptと同様に、上記のPythonコードも、応答ステータスコードとペイロード内で指定された新しいデータをログに記録します。

プットエンドポイントのテスト

APIデータの更新は、両方の言語で投稿して取得するのと同じプロセスを実行します。

JavaScriptのフェッチを使用してこれを行うには、PostをPutに置き換えるだけです。

// Specify the payload let payload = { title: 'new product', price: 13.5, description: 'test description', image: '', category: 'electronic' } fetch('https://fakestoreapi.com/products/19', { method: "Put", headers:{ 'Content-Type': 'application/json' }, body: JSON.stringify(payload) //convert the payload into JSON } ).then(res =>{ if (res.ok){ console.log(res.status) return res.json() } }).then(response => { console.log(response) }).catch(err => console.log(err))

APIエンドポイントに注目すると、今回は製品IDが含まれていることがわかります。これは、この場合に更新するデータをAPIが認識する方法です。

それでも、一部のAPIは、他のメソッドを使用してエンドポイントを作成する場合があります。したがって、それは標準ではありません。

Pythonを使用してAPIデータの更新をテストするには、代わりにrequests.putを使用します。

import requests payload = { 'title': 'new product', 'price': 13.5, 'description': 'test description', 'image': '', 'category': 'electronic' } Posted = requests.put('https://fakestoreapi.com/products/19', data = payload ) print(Posted.status_code) print(Posted.json())

上記の例は、成功した場合、APIエンドポイントによって示されるように位置19に新しいデータを挿入します。

削除リクエストのテスト

APIからデータを削除するのは、Getリクエストを作成するのと同じくらい簡単です。これは、PostやPutとは異なり、ペイロードを指定する必要がないためです。必要なのは削除エンドポイントだけです。

ここで選択したAPIは、製品IDを使用してデータを追跡します。したがって、製品の削除は簡単です。

fetch('https://fakestoreapi.com/products/19', { method: "Delete", headers:{ 'Content-Type': 'application/json' } } ).then(res =>{ if (res.ok){ console.log(res.status) return res.json() } }).then(response => { console.log(response) }).catch(err => console.log(err))

Pythonを使用して同じことを実現するには、数行のコードのみが必要です。

import requests Posted = requests.delete('https://fakestoreapi.com/products/19', ) print(Posted.status_code) print(Posted.json())

上記の両方の例は、クエリされたID（この場合は19）に属する応答ステータスコードとデータをログに記録します。

これらのテスト方法は一般的ですか？

この投稿では単一のAPIにのみ焦点を当てていますが、CRUDエンドポイントのテストに使用される方法は、他のAPIを扱う場合でも違いはありません。もちろん、唯一の違いは、各API構造を取り巻くルールとデータを要求するためのガイドラインにある可能性があります。選択したAPIについてこれらを解読したら、ここで説明する適切な方法を使用して、対応するエンドポイントをテストできます。

したがって、すべてのAPIには接続するためのルールがあるため、テスト中に、リクエストヘッダーに含める追加のパラメーターを提供するものもあります。このようなパラメータには通常、ドキュメントに記載されているアクセストークンなどが含まれます。