Fresopiya
場所にもお金にも時間にも、何にも縛られない自由な状態になったら一体人間は何をしてどこに向かうのか。

まずはとにかく自由を目指すエンジニアのブログです。
「哲学」と「プログラミング」と「政治経済」、「ブログ」がメインになるかと。
Java

【Java】「Spring Boot」でWebAPIの作成。JSONの受信と送信を行うサンプル。

どうも、とがみんです。

この記事では、JavaのSpring Frameworkの一つである「Spring Boot」を用いて、JSON形式のデータを受け取り、処理結果を返すWebAPIを作成する方法について紹介します。

今回作成するもの

今回は、人間かどうかを判別する簡単なAPIを作成していきます。

以下のように、人間と動物が混じったリストを送信すると、人間(human)のみが返ってくるというものです。

以下のように、typehumananimalの混じったリストを送信すると、typehumanのデータのみ返されます。

実装方法について

以下のステップで実装していきます。

  1. 受け取ったデータを保持するクラスの作成。
  2. 受け取ったJSONデータをリストに格納。
  3. 人間か動物かを判別するプログラム。

今回作成したファイルは以下の2つです。

上記ステップのそれぞれについて紹介してきます。

受け取ったデータを保持するクラスの作成。

受け取ったデータを格納するためのクラスを作成し、受け取ったJSON型のデータをJavaのプログラムで扱える形に格納するためのものです。

JSON:人間にとって読み書きが容易で、機械にとっても簡単にパースや生成を行なえるデータの形式。

CreatureDTO.javaファイルに以下の内容を記述します。
CreatureDTOクラスは、nametypeというプロパティを持ち、それぞれに値をセットするメソッドと、値を読み出すメソッドが書かれています。

受け取ったJSONデータをリストに格納。

次に、URLを叩いたあと、JSON形式のデータを受け取り、リストに格納するまでの処理についてです。

humanJudgeController.javaファイルに以下の内容を記述します。

①「@RestController」について

@RestControllerは、WebAPI用のコントローラーにつけるアノテーションです。これをつけることにより、メソッドの戻り値を任意のクラスのJavaオブジェクトにすると、「Jackson」というJavaオブジェクトとJSONの相互変換を行うライブラリが呼ばれて、返り値がJSON形式に変換してくれます。

>Spring MVCのコントローラでの戻り値いろいろ

②「@RequestMapping」について

@RequestMappingは、クライアントからのリクエストに対して、リクエストに応じたメソッドやハンドラに対応付けます。

valueは、URLのパスに対応し、methodは、GETやPOSTなどのメソッドを指定できます。

RequestMethod.POSTはPOSTによるアクセスの時にマッチします。

③「@RequestBody」について

@RequestBodyは、リクエストのBodyの内容を取得し、指定された型に値を注入します。JSONのキーにあたる部分と、オブジェクトのプロパティの変数名が一致するものに注入されます。

>Spring’s RequestBody and ResponseBody Annotations

人間か動物かを判別するプログラム。

最後に人間かどうかの判定をするプログラムを記述します。

Listは参照型のため、格納されるデータはアドレスになります。

creature.get(i).getType().equals(“human”)creature.get(i).getType() = “human”)と書く右辺には、“human”とか“animal”でなく、それが格納されているアドレスが格納されているので、結果は全てfalseになってしまうので注意が必要です。

>文字列と文字列の比較|Let’sプログラミング

動作の確認

動作の確認には、「Postman」というアプリを使用します。Postmanは作成したAPIが正しく動作するかどうかを確かめるためのツールです。

ダウンロードは以下から可能です。


下図のようにすると、作成したAPIの動作を確認することができます。

まとめ

Spring Bootで、JSON形式のデータの受信と送信を行うWebAPIを作成しました。

>Java Spring Bootで簡単・高速にWebAPI開発
>簡単!Spring BootでWebAPIをたたいてJSON形式のレスポンスをjavaオブジェクトに変換
>Spring BootでつくるCRUD API
>Spring MVCのドキュメント「コントローラを実装する」を読む(2)