Spring Boot DELETE エンドポイント パラメータとして電子メール アドレスを管理する最良の方法

Spring Boot での DELETE エンドポイントのクエリ パラメーターの使用

このアプローチでは、クエリ パラメーターを使用して電子メール アドレスを Spring Boot DELETE エンドポイントに渡す方法を示します。この方法は REST 原則に準拠していますが、機密データが安全に扱われるように注意する必要があります。

// Import necessary packages
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    // Inject UserService for business logic
    private final UserService userService;

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

    // Endpoint to soft-delete email address
    @DeleteMapping("/user/email")
    public ResponseEntity<String> softDeleteEmail(@RequestParam("email") String email) {
        boolean isDeleted = userService.softDeleteByEmail(email);

        if (isDeleted) {
            return ResponseEntity.ok("Email address soft-deleted successfully.");
        } else {
            return ResponseEntity.status(404).body("Email address not found.");
        }
    }
}

// Service logic
public class UserService {
    public boolean softDeleteByEmail(String email) {
        // Simulate database operation
        // Update 'status' column to 0 where email matches
        // Return true if operation succeeds
        return true;
    }
}

Spring Boot での DELETE エンドポイントのリクエスト本文の使用

このアプローチでは、リクエスト本文を使用して電子メール アドレスを渡します。 DELETE メソッドとしては異例ですが、これにより電子メールが URL に公開されなくなります。ここでは適切な検証が重要です。

// Import necessary packages
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    // Inject UserService for business logic
    private final UserService userService;

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

    // Endpoint to soft-delete email address
    @DeleteMapping("/user/email")
    public ResponseEntity<String> softDeleteEmail(@RequestBody EmailRequest emailRequest) {
        boolean isDeleted = userService.softDeleteByEmail(emailRequest.getEmail());

        if (isDeleted) {
            return ResponseEntity.ok("Email address soft-deleted successfully.");
        } else {
            return ResponseEntity.status(404).body("Email address not found.");
        }
    }
}

// Request Body Model
public class EmailRequest {
    private String email;

    // Getters and setters
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
}

// Service logic
public class UserService {
    public boolean softDeleteByEmail(String email) {
        // Simulate database operation
        // Update 'status' column to 0 where email matches
        // Return true if operation succeeds
        return true;
    }
}

エンドポイントの単体テスト

このスクリプトは、JUnit と MockMvc を使用して両方の実装を検証する DELETE エンドポイントの単体テストを提供します。

// Import packages
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.web.servlet.MockMvc;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(UserController.class)
public class UserControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testSoftDeleteByQueryParam() throws Exception {
        mockMvc.perform(delete("/user/email?email=test@example.com"))
               .andExpect(status().isOk());
    }

    @Test
    public void testSoftDeleteByRequestBody() throws Exception {
        String jsonBody = "{\"email\":\"test@example.com\"}";
        mockMvc.perform(delete("/user/email")
               .contentType("application/json")
               .content(jsonBody))
               .andExpect(status().isOk());
    }
}

DELETE エンドポイントに関するよくある質問

1. DELETE エンドポイントを保護する最善の方法は何ですか?
2. 安全な通信には HTTPS を使用し、機密データの漏洩を避けるためにログ編集フィルターを使用します。次のようなトークンベースの認可を検討してください。 JWT または OAuth。
3. DELETE リクエストに @RequestBody を使用できますか?
4. はい、型破りではありますが、Spring Boot はサポートしています @RequestBody DELETE リクエストの場合、リクエストのペイロードにデータを含めることができます。
5. Spring Boot で電子メール アドレスを検証するにはどうすればよいですか?
6. 正規表現または次のようなライブラリを使用します Apache Commons Validator 処理する前に電子メールの形式が正しいことを確認します。
7. 機密データをクエリ パラメーターで渡す必要がありますか?
8. を使用してデータを保護しない限り、これは推奨されません HTTPS また、機密情報をマスクするための堅牢なロギング手法を実装します。
9. DELETE エンドポイントをテストするにはどうすればよいですか?
10. 使用 MockMvc 単体テストやツールの場合 Postman 手動テスト用。成功ケースや失敗ケースなど、さまざまなシナリオに対する応答を検証します。

効果的なパラメータ処理のための重要なポイント

DELETE エンドポイントにクエリ パラメーターを使用するかリクエスト本文を使用するかを決定する際の選択は、REST 準拠とデータ保護の優先順位に大きく依存します。どちらのアプローチにもトレードオフがありますが、HTTPS とログ記録の実践では、クエリ パラメーターが受け入れられることがよくあります。 🛡️

入力の検証、安全な送信、および適切な認可を確保することで、実装が強化されます。思慮深い設計により、Spring Boot アプリケーションは機能とユーザーの信頼の両方を維持し、よりクリーンで安全な API への道を切り開くことができます。 🔧