導入

Spring Boot は、包括的なツールと規約のスイートを提供することでソフトウェア開発プロセスを簡素化する強力な Java フレームワークです。使いやすさと強力な機能により、小規模アプリケーションと大規模アプリケーションの両方で人気の選択肢となっています。アプリケーションを構築する際、アプリケーション内でサードパーティ API を使用する必要がある場合があります。

Spring Boot で API にリクエストを行うには、RestTemplate、WebSocket、Apache HttpClient、OkHttp、FeignClient の使用など、いくつかの方法があります。多くの場合、方法の選択はアプリケーションの特定の要件によって決まります。この記事では、RestTemplate.

RestTemplateとは何ですか?

RestTemplate は Spring によって提供される同期クライアントで、HTTP リクエストの送信と応答の処理のための簡単で直感的な API を提供します。これは、Spring Web 依存関係に含まれる Spring のパッケージです。そのメソッドは理解しやすく、あらゆるスキル レベルの開発者が利用できます。

認証済み POST リクエストの作成方法

認証された POST リクエストを作成する方法を示すために、https://api.example.com/create でサードパーティ API 経由でアカウントを作成する必要があるウォレット アプリケーションを構築するシナリオを考えてみましょう。

要件：

API には次のものが必要です:

• ヘッダー: 認可ベアラー
• 本文パラメータ: 名前、電子メール、bvn

ステップ

1. RestTemplate オブジェクトを作成します。
2. HTTP ヘッダーのセットアップ: HttpHeaders を使用して、認可トークンを運ぶヘッダーを作成します。
3. HttpEntity の作成: 予期されるリクエスト本文と HTTP ヘッダーを使用して HttpEntity オブジェクトを構築します。
4. POST リクエストを作成します: RestTemplate の postForObject メソッドを使用してリクエストを送信します。

コード例

String url = "https://api.example.com/create";

RestTemplate restTemplate = new RestTemplate();

HttpHeaders httpHeaders = new HttpHeaders();

httpHeaders.setBasicAuth(token);

HttpEntity

この設定では、トークンが有効であれば、API への POST リクエストを正常に行うことができます。

認証済み GET リクエストの作成方法

認証された GET リクエストを行うには、RestTemplate の交換メソッドを使用します。

コード例

String url = "https://api.example.com/balance";

HttpHeaders httpHeaders = new HttpHeaders();

httpHeaders.setBasicAuth(token);

HttpEntity

これらの手順に従うことで、トークンが有効であれば、API に GET リクエストを行うことができます。

結論

この記事では、SpringBoot の RestTemplate を使用してサードパーティ API に対して認証された POST リクエストと GET リクエストを行う方法について説明しました。 RestTemplate を利用すると、必要な認証ヘッダーを含めるようにリクエストを簡単に構成できます。

追加メモ

• 環境変数または暗号化された構成ファイルを使用して、API キーやパスワードなどの機密データが安全に保管されていることを常に確認してください。
• リアクティブ プログラミング用の WebClient や、より複雑なアプリケーションの宣言型 API クライアント用の FeignClient など、他のオプションを検討することを検討してください。

他の記事については、私のソーシャル ハンドルをフォローしてください:
クリックしてフォローしてください

• リンクトイン
• ツイッター
• 開発
• 中くらい