【3分でできる】Spring bootでREST APIを使う方法

今回は、Spring bootでREST APIを使う方法について紹介します。

使い方はとても簡単で、以下のアノテーションを記述するだけで実装できます。

@RestController
@RequestMapping
@GetMapping
@PostMapping

コードはこのようになります。

package com.example.demo.controller;

import java.time.LocalDate;
import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.example.demo.domain.Datetime;
import com.example.demo.service.DatetimeService;


/*RestController*/
@RestController
@RequestMapping("/api")
public class DatetimeRestController {

	@Autowired
	private DatetimeService datetimeService;

	/*一覧情報を取得する*/
	@GetMapping
	public List<Datetime> getDatetimeAll(){
		return datetimeService.findAll();
	}

	/*IDで個別のデータを取得する*/
	@GetMapping(value = "{dateId}")
	public Datetime getDatetime(@PathVariable("dateId") Long dateId) {
		return datetimeService.findOne(dateId);
	}

	/*POSTで入植された文字列をLocalDateにして返す*/
	@PostMapping(value = "{baseDate}")
	public LocalDate calulationDate(@PathVariable("baseDate") String baseDate){
		LocalDate date = datetimeService.convertToLocalDate(baseDate, "yyyyMMdd");
		return date;
	}
	
}

package com.example.demo.controller;

import java.time.LocalDate;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.PostMapping;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import com.example.demo.domain.Datetime;

import com.example.demo.service.DatetimeService;

/*RestController*/

@RestController

@RequestMapping("/api")

public class DatetimeRestController {

@Autowired

private DatetimeService datetimeService;

/*一覧情報を取得する*/

@GetMapping

public List<Datetime> getDatetimeAll(){

return datetimeService.findAll();

}

/*IDで個別のデータを取得する*/

@GetMapping(value = "{dateId}")

public Datetime getDatetime(@PathVariable("dateId") Long dateId) {

return datetimeService.findOne(dateId);

}

/*POSTで入植された文字列をLocalDateにして返す*/

@PostMapping(value = "{baseDate}")

public LocalDate calulationDate(@PathVariable("baseDate") String baseDate){

LocalDate date = datetimeService.convertToLocalDate(baseDate, "yyyyMMdd");

return date;

}

これで「http://localhost:8080/api/」にアクセスすると、該当するデータがJSON形式で返ってきます。

同じように「http://localhost:8080/api/1」にアクセスすると、該当する個別のデータが取得できます。

POSTは、ブラウザで確認することはできません。

curlコマンドを使って確認します。
(ターミナル・コマンドプロントを使用してください。)

curl -X POST http://localhost:8080 -d "dateStandart=20110101"

1	curl -X POST http://localhost:8080 -d "dateStandart=20110101"

まとめ

いかがでしたか？

Spring bootでは簡単にREST APIを簡単に実装できます。

ぜひ、1度試してください。