この記事の要点
@RequestMapping はURL パスとコントローラ・メソッドを紐付ける クラス全体に付与すると共通プレフィックス、メソッドに付与すると個別 URL HTTP メソッド指定: @GetMapping / @PostMapping / @PutMapping / @DeleteMapping / @PatchMapping がショートカット パラメータ・ヘッダ・consumes / produces でマッチ条件を絞り込み

 

基本的な使い方

@RestController
@RequestMapping("/api/users")  // ← クラスレベル：共通プレフィックス
public class UserController {

    @RequestMapping(method = RequestMethod.GET)
    public List<User> list() { ... }   // GET /api/users

    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    public User get(@PathVariable Long id) { ... }   // GET /api/users/123

    @RequestMapping(method = RequestMethod.POST)
    public User create(@RequestBody User user) { ... }   // POST /api/users
}

HTTP メソッド別ショートカット（推奨）

HTTP メソッド	ショートカット	@RequestMapping 等価
GET	@GetMapping	@RequestMapping(method = RequestMethod.GET)
POST	@PostMapping	@RequestMapping(method = RequestMethod.POST)
PUT	@PutMapping	@RequestMapping(method = RequestMethod.PUT)
DELETE	@DeleteMapping	@RequestMapping(method = RequestMethod.DELETE)
PATCH	@PatchMapping	@RequestMapping(method = RequestMethod.PATCH)

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

    @GetMapping            public List<User> list() { ... }
    @GetMapping("/{id}")   public User get(@PathVariable Long id) { ... }
    @PostMapping           public User create(@RequestBody User user) { ... }
    @PutMapping("/{id}")   public User update(@PathVariable Long id, @RequestBody User u) { ... }
    @DeleteMapping("/{id}") public void delete(@PathVariable Long id) { ... }
}

主要な属性

属性	用途
value / path	URL パス（複数指定可）
method	HTTP メソッド（複数指定可）
params	クエリパラメータ条件
headers	HTTP ヘッダ条件
consumes	受け付ける Content-Type
produces	返す Content-Type

マッチング条件で絞り込む

① クエリパラメータ条件

// type=admin が必須
@GetMapping(value = "/users", params = "type=admin")
public List<User> listAdmins() { ... }

// type が指定されていない
@GetMapping(value = "/users", params = "!type")
public List<User> listAll() { ... }

// 複数条件
@GetMapping(value = "/users", params = {"status=active", "role"})
public List<User> listActiveByRole(...) { ... }

② ヘッダ条件

@GetMapping(value = "/data", headers = "X-API-Version=2")
public DataV2 getV2() { ... }

@PostMapping(value = "/upload", headers = "Content-Type=multipart/form-data")
public Response upload(...) { ... }

③ Content-Type / Accept ヘッダ（consumes / produces）

// JSON のみ受け付ける
@PostMapping(value = "/users", consumes = "application/json")
public User create(@RequestBody User user) { ... }

// 複数の Content-Type 対応
@PostMapping(consumes = {"application/json", "application/xml"})
public User create(@RequestBody User user) { ... }

// JSON でレスポンスを返す（クライアント Accept ヘッダで判定）
@GetMapping(value = "/{id}", produces = "application/json")
public User get(...) { ... }

// CSV を返す
@GetMapping(value = "/export", produces = "text/csv")
public String exportCsv() { ... }

複数 URL を 1 つのメソッドに

@GetMapping({"/users", "/users/"})  // 末尾スラッシュあり・なし両対応
public List<User> list() { ... }

// クラスとメソッド両方で複数
@RequestMapping({"/api/users", "/api/v2/users"})
public class UserController {
    @GetMapping
    public List<User> list() { ... }
    // → /api/users, /api/v2/users 両方でアクセス可
}

パスパターン（ワイルドカード）

// ?: 1 文字ワイルドカード
@GetMapping("/items/?")
public Item get(@PathVariable String id) { ... }

// *: 1 セグメントワイルドカード
@GetMapping("/items/*")
public List<Item> list() { ... }

// **: 0 以上のセグメント
@GetMapping("/files/**")
public Resource serve(HttpServletRequest req) {
    String path = req.getRequestURI().substring("/files/".length());
    // ファイル配信
}

// 正規表現
@GetMapping("/items/{id:[0-9]+}")
public Item get(@PathVariable Long id) { ... }

注意: @RequestMapping と @RestController の組み合わせ

// 良い例
@RestController
@RequestMapping("/api/users")
public class UserController { ... }

// 古い例（今は @RestController + @RequestMapping のほうが明示的）
@Controller
@ResponseBody
@RequestMapping("/api/users")
public class UserController { ... }

関連記事

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