APIコールの成功時に返されるステータスコードとその意味

2024-02-09 12:14 APIステータスコード成功
  1. 200 OK: リクエストが正常に処理され、要求されたリソースが返されました。このステータスコードは、成功したAPIコールを示します。

以下に、異なるシナリオでのAPIコールの成功時に返されるステータスコードとその意味をいくつか示します。

  1. 201 Created: リクエストが成功し、新しいリソースが作成されました。通常、POSTリクエストが成功した場合に返されます。

  2. 204 No Content: リクエストが成功し、サーバーからコンテンツが返されませんでした。通常、PUTまたはDELETEリクエストが成功した場合に返されます。

これらのステータスコードは、HTTPプロトコルで一般的に使用されるものですが、APIによっては独自のステータスコードを使用する場合もあります。APIのドキュメントを確認して、特定のAPIがどのステータスコードを使用するかを確認してください。

以下に、いくつかの一般的なプログラミング言語でのAPIコールの成功時のコード例を示します。

Python:

import requests
response = requests.get('https://api.example.com/users')
if response.status_code == 200:
    print('API call successful')
else:
    print('API call failed')

JavaScript (Node.js):

const fetch = require('node-fetch');
fetch('https://api.example.com/users')
    .then(response => {
        if (response.ok) {
            console.log('API call successful');
        } else {
            console.log('API call failed');
        }
    });

このように、APIコールの成功時には適切なステータスコードを確認して処理を行うことが重要です。