TOC

REST APIにおけるHTTP PUTとHTTP PATCH

REST APIでのHTTP PUTとHTTP PATCH

1. 概要

この簡単な記事では、HTTP PUT動詞とPATCH動詞の違いと、2つの操作のセマンティクスについて説明します。

Springを使用して、これら2つのタイプの操作をサポートする2つのRESTエンドポイントを実装し、違いとそれらの正しい使用方法をよりよく理解します。

2. いつプットを使用し、いつパッチを適用するか？

単純で少し単純なステートメントから始めましょう。

クライアントが既存のリソースを完全に置き換える必要がある場合は、PUTを使用できます。 部分的な更新を行う場合は、HTTPPATCHを使用できます。

たとえば、リソースの単一のフィールドを更新する場合、完全なリソース表現を送信するのは面倒で、多くの不必要な帯域幅を利用します。 そのような場合、PATCHのセマンティクスはより意味があります。

ここで考慮すべきもう1つの重要な側面は、idempotence; PUT is idempotent; PATCH can be, but isn’t required toです。 したがって、実装している操作のセマンティクスに応じて、この特性に基づいてどちらかを選択することもできます。

3. PUTおよびPATCHロジックの実装

複数のフィールドを持つHeavyResourceを更新するためのRESTAPIを実装するとします。 

public class HeavyResource {
    private Integer id;
    private String name;
    private String address;
    // ...

まず、PUTを使用してリソースの完全な更新を処理するエンドポイントを作成する必要があります。 

@PutMapping("/heavyresource/{id}")
public ResponseEntity saveResource(@RequestBody HeavyResource heavyResource,
  @PathVariable("id") String id) {
    heavyResourceRepository.save(heavyResource, id);
    return ResponseEntity.ok("resource saved");
}

これは、リソースを更新するための標準エンドポイントです。

ここで、アドレスフィールドがクライアントによって更新されることが多いとしましょう。 その場合、we don’t want to send the whole HeavyResource object with all fieldsですが、PATCHメソッドを介してaddressフィールドのみを更新する機能が必要です。

アドレスフィールドの部分的な更新を表すHeavyResourceAddressOnlyDTOを作成できます。 

public class HeavyResourceAddressOnly {
    private Integer id;
    private String address;

    // ...
}

次に、PATCHメソッドを活用して部分的な更新を送信できます。 

@PatchMapping("/heavyresource/{id}")
public ResponseEntity partialUpdateName(
  @RequestBody HeavyResourceAddressOnly partialUpdate, @PathVariable("id") String id) {

    heavyResourceRepository.save(partialUpdate, id);
    return ResponseEntity.ok("resource address updated");
}

このより詳細なDTOを使用すると、HeavyResource全体を送信するオーバーヘッドなしに、更新する必要があるフィールドのみを送信できます。

これらの部分的な更新操作が多数ある場合は、出力ごとにカスタムDTOの作成をスキップして、マップのみを使用することもできます。 

@RequestMapping(value = "/heavyresource/{id}", method = RequestMethod.PATCH, consumes = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity partialUpdateGeneric(
  @RequestBody Map updates,
  @PathVariable("id") String id) {

    heavyResourceRepository.save(updates, id);
    return ResponseEntity.ok("resource updated");
}

このソリューションにより、APIをより柔軟に実装できます。ただし、検証などいくつかのことも失います。

4. PUTとPATCHのテスト

最後に、両方のHTTPメソッドのテストを作成しましょう。 まず、PUTメソッドを使用してリソース全体の更新をテストします。 

mockMvc.perform(put("/heavyresource/1")
  .contentType(MediaType.APPLICATION_JSON_VALUE)
  .content(objectMapper.writeValueAsString(
    new HeavyResource(1, "Tom", "Jackson", 12, "heaven street")))
  ).andExpect(status().isOk());

部分更新の実行は、PATCHメソッドを使用して実現されます。 

mockMvc.perform(patch("/heavyrecource/1")
  .contentType(MediaType.APPLICATION_JSON_VALUE)
  .content(objectMapper.writeValueAsString(
    new HeavyResourceAddressOnly(1, "5th avenue")))
  ).andExpect(status().isOk());

また、より一般的なアプローチのテストを作成することもできます。 

HashMap updates = new HashMap<>();
updates.put("address", "5th avenue");

mockMvc.perform(patch("/heavyresource/1")
    .contentType(MediaType.APPLICATION_JSON_VALUE)
    .content(objectMapper.writeValueAsString(updates))
  ).andExpect(status().isOk());

5. Null値を使用した部分リクエストの処理

PATCHメソッドの実装を作成するときは、HeavyResourceAddressOnly.のaddressフィールドの値としてnullを取得した場合のケースの処理方法のコントラクトを指定する必要があります。

クライアントが次のリクエストを送信するとします。 

{
   "id" : 1,
   "address" : null
}

次に、これをaddressフィールドの値をnullに設定するか、変更なしとして扱うことでそのような要求を単に無視するものとして処理できます。

nullを処理するための戦略を1つ選び、すべてのPATCHメソッドの実装でそれに固執する必要があります。

6. 結論

このクイックチュートリアルでは、HTTP PATCHメソッドとPUTメソッドの違いを理解することに焦点を当てました。

単純なSpring RESTコントローラーを実装して、PUTメソッドを介してリソースを更新し、PATCHを使用して部分的に更新します。

これらすべての例とコードスニペットの実装は、GitHub projectにあります。これはMavenプロジェクトであるため、そのままインポートして実行するのは簡単です。

Related