この記事の要点
@RestController はREST API のコントローラを表す Spring MVC アノテーション @Controller + @ResponseBody をまとめたもの クラス内のすべてのメソッドの戻り値が自動で JSON / XML 化される（View 解決をしない） 通常の View を返す場合は @Controller、API なら @RestController

 

@RestController の基本

@RestController
@RequestMapping("/api/users")
public class UserController {

    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    @GetMapping("/{id}")
    public UserDto get(@PathVariable Long id) {
        return userService.findById(id);
        // ← 自動で JSON 化されてレスポンスボディに書き出される
    }

    @PostMapping
    @ResponseStatus(HttpStatus.CREATED)
    public UserDto create(@RequestBody UserCreateRequest req) {
        return userService.create(req);
    }

    @PutMapping("/{id}")
    public UserDto update(@PathVariable Long id, @RequestBody UserUpdateRequest req) {
        return userService.update(id, req);
    }

    @DeleteMapping("/{id}")
    @ResponseStatus(HttpStatus.NO_CONTENT)
    public void delete(@PathVariable Long id) {
        userService.delete(id);
    }
}

@RestController vs @Controller

項目	@RestController	@Controller
用途	REST API	HTML View 返却
戻り値	JSON / XML として直接出力	View 名として解釈、テンプレート探す
@ResponseBody	クラス全体に暗黙適用	個別メソッドに付ける必要
典型例	外部 API / SPA バックエンド	サーバサイドレンダリング

レスポンスの型

① POJO / DTO（標準）

@GetMapping("/{id}")
public UserDto get(@PathVariable Long id) {
    return userService.findById(id);
}
// → {"id": 1, "name": "Alice", "email": "..."}

② List / Map

@GetMapping
public List<UserDto> list() {
    return userService.findAll();
}

@GetMapping("/summary")
public Map<String, Object> summary() {
    return Map.of(
        "total", 100,
        "active", 80
    );
}

③ ResponseEntity（ステータス・ヘッダ制御）

@GetMapping("/{id}")
public ResponseEntity<UserDto> get(@PathVariable Long id) {
    return userService.findByIdOptional(id)
        .map(ResponseEntity::ok)
        .orElseGet(() -> ResponseEntity.notFound().build());
}

@PostMapping
public ResponseEntity<UserDto> create(@RequestBody UserCreateRequest req) {
    UserDto created = userService.create(req);
    URI location = URI.create("/api/users/" + created.getId());
    return ResponseEntity.created(location).body(created);
}

④ ストリーミング

@GetMapping(value = "/export", produces = "text/csv")
public ResponseEntity<StreamingResponseBody> export() {
    StreamingResponseBody body = out -> {
        userService.streamAll().forEach(user -> {
            try {
                out.write((user.toCsvLine() + "\n").getBytes(StandardCharsets.UTF_8));
            } catch (IOException e) { throw new RuntimeException(e); }
        });
    };
    return ResponseEntity.ok()
        .header("Content-Disposition", "attachment; filename=\"users.csv\"")
        .body(body);
}

例外ハンドリング

@RestController
public class UserController {

    @GetMapping("/{id}")
    public UserDto get(@PathVariable Long id) {
        return userService.findById(id)
            .orElseThrow(() -> new ResponseStatusException(HttpStatus.NOT_FOUND, "User not found"));
    }

    @ExceptionHandler(UserNotFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public ErrorResponse handleNotFound(UserNotFoundException ex) {
        return new ErrorResponse("USER_NOT_FOUND", ex.getMessage());
    }

    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public Map<String, String> handleValidation(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getFieldErrors().forEach(error ->
            errors.put(error.getField(), error.getDefaultMessage())
        );
        return errors;
    }
}

// グローバルエラーハンドラ
@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public ErrorResponse handleAll(Exception ex) {
        log.error("Unexpected", ex);
        return new ErrorResponse("INTERNAL_ERROR", "システムエラー");
    }
}

関連記事

• @RequestMapping
• @PathVariable
• @ResponseBody
• @RequestBody
• アノテーション一覧