SpringBoot 外部のサービス・Web APIを呼び出す方法

Spring Boot のアプリで、JSON を返す外部のサービス（Web API）を呼び出す方法を書いていきます。

バージョン

動作確認で使用した製品のバージョンは以下の通りです。

Spring Boot 3.0.1
Lombok 1.8.24
Java 17

1. JSONを文字列として受け取る方法

RestTemplate で外部のサービスを呼び出します。

src/main/java/org/example/controller/ExStringController.java

package org.example.controller;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@RestController
public class ExStringController {
  private static final String url = "https://...";
  private static final RestTemplate restTemplate = new RestTemplate();

  @GetMapping("/ex/string")
  public ResponseEntity<String> exchange() {
    // Web API を HTTP GET で呼び出します。
    ResponseEntity<String> res
      = restTemplate.getForEntity(url, String.class);
    String json = res.getBody();
    return res;
  }
}

2. JSONをオブジェクトで受け取る方法

今回は例として、外部の REST API から以下の JSON を受け取ることにします。

{"id":1,"name":"佐藤"}

JSON をバインドするクラスを用意します。

src/main/java/org/example/model/Person.java

package org.example.model;

import lombok.Getter;
import lombok.Setter;

@Getter @Setter
public class Person {
  private long id;
  private String name;
}

RestTemplate のメソッドで、上のクラスを指定します。

src/main/java/org/example/controller/ExObjectController.java

package org.example.controller;

import org.example.model.Person;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@RestController
public class ExObjectController {
  private static final String url = "https://...";
  private static final RestTemplate restTemplate = new RestTemplate();

  @GetMapping("/ex/object")
  public Person exchange() {
    // Web API を HTTP GET で呼び出します。
    return restTemplate.getForObject(url, Person.class);
  }
}

3. 動作確認

3. 1. ビルドファイルの作成

Maven のビルドファイルを作成します。

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.0.1</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>

  <groupId>org.example</groupId>
  <artifactId>spring-exchange</artifactId>
  <version>1.0.0</version>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>17</java.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
</project>

3.2. アプリ起動クラスの作成

アプリを起動するクラスを作成します。

src/main/java/org/example/SpringApp.java

package org.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringApp {
  public static void main(String[] args) {
    SpringApplication.run(SpringApp.class, args);
  }
}

3.3. アプリの起動と確認

アプリを起動して以下の URL にアクセスすると、JSON を受け取ることができます。

http://localhost:8080/ex/string

http://localhost:8080/ex/object

Web系開発メモ

Java, C#, HTML, CSS, JavaScript のことなどを書いてます。