ちょっと、そこ！ API サプライヤーとして、私は Java で API 呼び出しを行う方法についてよく質問されます。最初は少し難しそうに思えるかもしれませんが、一度コツを掴めば、実際には非常に簡単です。このブログでは、プロのように Java で API 呼び出しを開始できるように、プロセスを段階的に説明します。
APIとは何ですか?
Java で API 呼び出しを行う前に、API とは何かを簡単に説明しましょう。 API はアプリケーション プログラミング インターフェイスの略です。これは、さまざまなソフトウェア アプリケーションが相互に通信できるようにする一連のルールとプロトコルです。これは、Java アプリケーションが外部サービスまたはデータ ソースと対話できるようにするブリッジとして考えてください。
API 呼び出しに Java を使用する理由
Java は、いくつかの理由から API 呼び出しを行うための人気のあるプログラミング言語です。プラットフォームに依存しないため、コードを一度作成すれば、どのオペレーティング システムでも実行できます。また、大規模で活発なコミュニティがあるため、API 呼び出しに役立つライブラリやリソースを簡単に見つけることができます。さらに、Java の強力な型指定とオブジェクト指向の性質により、Java は API と対話するアプリケーションを構築するための信頼性が高く安全な選択肢となります。
前提条件
Java で API 呼び出しを開始する前に、いくつかのことが必要です。
- Java 開発キット (JDK): コンピューターに JDK がインストールされている必要があります。 Oracle の公式 Web サイトからダウンロードすることも、OpenJDK などのオープンソースの代替手段を使用することもできます。
- 統合開発環境 (IDE): IntelliJ IDEA や Eclipse などの IDE を使用すると、開発プロセスがはるかに簡単になります。コード補完、デバッグ、プロジェクト管理などの機能を提供します。
- API キー (必要な場合): 一部の API では、リクエストを認証するために API キーが必要です。呼び出しを開始する前に、必要な API キーを持っていることを確認してください。
Java で単純な API 呼び出しを行う
まずは、パブリック API への簡単な API 呼び出しを行ってみましょう。この例では、テストとプロトタイピング用の偽のデータを提供する JSONPlaceholder API を使用します。
まず、必要な依存関係をプロジェクトに追加する必要があります。 Maven を使用している場合は、次の依存関係をpom.xmlファイル：
<依存関係> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <バージョン>4.5.13</version> </dependency>JSONPlaceholder API に対して GET リクエストを行う Java コードは次のとおりです。
org.apache.http.HttpResponse をインポートします。 org.apache.http.client.HttpClientをインポートします。 org.apache.http.client.methods.HttpGet をインポートします。 org.apache.http.impl.client.HttpClients をインポートします。 org.apache.http.util.EntityUtils をインポートします。インポート java.io.IOException; public class APICallExample { public static void main(String[] args) { try { // HTTP クライアントを作成します HttpClient httpClient = HttpClients.createDefault(); // HTTP GET リクエストを作成します HttpGet httpGet = new HttpGet("https://jsonplaceholder.typicode.com/posts/1"); // リクエストを実行します。 HttpResponse response = httpClient.execute(httpGet); // レスポンスボディを文字列として取得します String responseBody = EntityUtils.toString(response.getEntity()); // レスポンスボディを出力します System.out.println(responseBody); } catch (IOException e) { e.printStackTrace(); } } }このコードでは、最初にHTTPクライアントHTTP リクエストを送信するために使用されるオブジェクト。次に、httpGet呼び出したい API エンドポイントの URL を含むオブジェクト。を使用してリクエストを実行します。実行するの方法HTTPクライアントオブジェクトを取得し、次に、を使用して応答本文を文字列として取得します。EntityUtils.toString方法。最後に、応答本文をコンソールに出力します。
API 応答の処理
API 呼び出しを行ったら、応答を処理する必要があります。 API からの応答は、JSON、XML、プレーン テキストなどのさまざまな形式にすることができます。ほとんどの場合、API は JSON 形式でデータを返すため、Java で JSON 応答を解析する方法を見てみましょう。
Gson などのライブラリを使用して JSON 応答を解析できます。まず、Gson 依存関係をpom.xmlファイル：
<dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> <version>2.8.8</version> </dependency>Gson を使用して JSON 応答を解析する方法の例を次に示します。
com.google.gson.Gson をインポートします。 org.apache.http.HttpResponse をインポートします。 org.apache.http.client.HttpClientをインポートします。 org.apache.http.client.methods.HttpGet をインポートします。 org.apache.http.impl.client.HttpClients をインポートします。 org.apache.http.util.EntityUtils をインポートします。インポート java.io.IOException; java.util.Mapをインポートします。 public class JSONParsingExample { public static void main(String[] args) { try { HttpClient httpClient = HttpClients.createDefault(); HttpGet httpGet = new HttpGet("https://jsonplaceholder.typicode.com/posts/1"); HttpResponse 応答 = httpClient.execute(httpGet);文字列 responseBody = EntityUtils.toString(response.getEntity()); // Gson Gson gson = new Gson(); を使用して JSON 応答を解析します。 Map<String, Object> jsonMap = gson.fromJson(responseBody, Map.class); // 投稿のタイトルを出力します System.out.println("Title: " + jsonMap.get("title")); } catch (IOException e) { e.printStackTrace(); } } }このコードでは、まず JSONPlaceholder API への API 呼び出しを行い、応答本文を文字列として取得します。次に、グソン反対してそれを使用するfromJsonJSON 文字列を解析して地図物体。最後に、にアクセスして投稿のタイトルを出力します。タイトルキーを押します地図。
POSTリクエストの実行
GET リクエストに加えて、API への POST リクエストも行う必要がある場合があります。 POST リクエストは、新しいリソースの作成など、API にデータを送信するために使用されます。
Java で POST リクエストを作成する方法の例を次に示します。
org.apache.http.HttpResponse をインポートします。 org.apache.http.client.HttpClientをインポートします。 org.apache.http.client.methods.HttpPost をインポートします。 org.apache.http.entity.StringEntity をインポートします。 org.apache.http.impl.client.HttpClients をインポートします。 org.apache.http.util.EntityUtils をインポートします。インポート java.io.IOException; public class PostRequestExample { public static void main(String[] args) { try { HttpClient httpClient = HttpClients.createDefault(); HttpPost httpPost = new HttpPost("https://jsonplaceholder.typicode.com/posts"); // リクエストボディを設定します。 String json = "{\"title\": \"foo\", \"body\": \"bar\", \"userId\": 1}"; StringEntity エンティティ = 新しい StringEntity(json); httpPost.setEntity(エンティティ); httpPost.setHeader("コンテンツタイプ", "アプリケーション/json"); // リクエストを実行します。 HttpResponse response = httpClient.execute(httpPost);文字列 responseBody = EntityUtils.toString(response.getEntity()); // レスポンスボディを出力します System.out.println(responseBody); } catch (IOException e) { e.printStackTrace(); } } }このコードでは、最初にhttpPost呼び出したい API エンドポイントの URL を含むオブジェクト。次に、を作成してリクエスト本文を設定します。文字列エンティティオブジェクトを作成し、それをエンティティとして設定しますhttpPost物体。また、コンテンツタイプへのヘッダーアプリケーション/jsonJSON データを送信していることを示します。最後に、リクエストを実行し、レスポンスの本文を出力します。
当社の API サービス
API サプライヤーとして、当社はさまざまな業界やユースケース向けに幅広い API を提供しています。探しているかどうか1mm、1.5mm、2mm 標準準備ボード 標準 PLC ボード 標準シリカゲルプレート サイズ 200*200m、3-ブチル-2-(1-エチルペンチル)オキサゾリジン CAS NO 165101-57-5、 または0.5 ミリメートル、1 ミリメートル、1.5 ミリメートル、2 ミリメートル高効率準備プレート PLC シリカゲルプレート準備プレート大型 200*200 ミリメートル、私たちはあなたをカバーします。
当社の API は使いやすく、既存のアプリケーションに統合できるように設計されています。すぐに使い始められるよう、詳細なドキュメントとサポートを提供します。弊社の API の使用にご興味がございましたら、無料トライアルまたは特定の要件についてお気軽にお問い合わせください。
結論
Java で API 呼び出しを行うことは、アプリケーションの可能性を広げる貴重なスキルです。このブログで説明されている手順に従うことで、Java で API 呼び出しを行う方法、応答を処理する方法、および POST リクエストを行う方法を十分に理解できるようになります。
ご質問がある場合、またはさらにサポートが必要な場合は、お気軽にお問い合わせください。私たちは、お客様が API を最大限に活用し、アプリケーションを次のレベルに引き上げられるようお手伝いいたします。
参考文献
- Apache HttpClient ドキュメント
- Gson ドキュメント
- JSONPlaceholder API ドキュメント
