【Spring MVC】RestTemplateを使ったAPIアクセス（exchangeを使ったPOST通信）

概要

RestTemplate#exchangeメソッドの基本的なPOST通信の使用方法についてまとめた。
動作確認を行うための事前準備については、以下に記載している。

あわせて読みたい

【Spring MVC】RestTemplateの導入

概要 RESTfulなAPIを呼ぶクライアントライブラリである、RestTemplateの概要についてまとめた。 RestTemplateを使用するための準備と、どんなメソッドがあるのかを紹介している。   前提 今[…]

基本的な使い方

exchangeメソッドは、HTTP メソッド（GET, POST, PUT, DELETE など）を柔軟に扱うことができる。
戻り値は、HTTPステータス/ヘッダー/ボディを含むResponseEntityオブジェクトとなる。

今回は基本的なPOST通信を行う方法について紹介する。

実装方法

RestTemplate#exchangeメソッドを使用してPOST通信を行うには、基本的に以下のように実装する。

「RequestEntity.post」と指定することで、リクエストボディを設定してPOST通信が可能となる。

戻り値は指定したレスポンスの型をボディにもつResponseEntityとなる。
尚、RequestEntityにはリクエストヘッダー/ボディ/HTTPメソッド（今回はPOST）を指定できる。

使用例

GET通信の記事にて追加したexchangeメソッドを使用して動作確認を行う。

APIアクセスクラス

以下のexchangeメソッドを使用する。

RestClient.java

package com.example.client_prototype.biz;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.http.RequestEntity;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;

@Component
public class RestClient {

	@Autowired
	private RestTemplate restTemplate;
	
	/**
	 * exchangeの利用
	 * @param <T>
	 * @param requestEntity
	 * @param responseType
	 * @return
	 */
	public <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, Class<T> responseType) {
		return restTemplate.exchange(requestEntity, responseType);
	}
	
	/**
	 * exchangeの利用
	 * @param <T>
	 * @param requestEntity
	 * @param responseType
	 * @return
	 */
	public <T> ResponseEntity<List<T>> exchange(RequestEntity<?> requestEntity, ParameterizedTypeReference<List<T>> responseType) {
	    return restTemplate.exchange(requestEntity, responseType);
	}
}

動作確認

動作確認を行う。

動作確認用クラス

// リクエストボディ
var req = new Resource("4", "パスタ", LocalDate.of(2022, 5, 1));

// POSTリクエスト
RequestEntity<Resource> reqEntity = RequestEntity
		.post(URI.create("http://localhost:8080/rest_prototype/rest02/create"))
		.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
		.body(req);

ResponseEntity<Void> resEntity = restClient.exchange(reqEntity, Void.class);

// 動作確認
System.out.println(resEntity.getStatusCode());
System.out.println(resEntity.getHeaders());
System.out.println(resEntity.getBody());

指定したURIにPOSTリクエストを行うRequestEntityクラスを作成している。

コンテンツタイプ（Content-Type）をJSON（application/json）としている。
リクエストボディをJSON形式で送るという意味。

ResourceオブジェクトをPOSTのリクエストボディに設定している。

コンソール

201 CREATED
[Location:"http://localhost:8080/rest_prototype/rest01/4", Content-Length:"0", Date:"Wed, 26 Mar 2025 10:48:24 GMT", Keep-Alive:"timeout=20", Connection:"keep-alive"]
null

まとめ