知識庫 / REST RSS 訂閱

public CompletionStage<Result> update(Http.Request request) {
    JsonNode json = request.body().asJson();
    return supplyAsync(() -> {
        if (json == null) {
            return badRequest(Util.createResponse("Expecting Json data", false));
        }
        Optional<Student> studentOptional = studentStore.updateStudent(Json.fromJson(json, Student.class));
        return studentOptional.map(student -> {
            if (student == null) {
                return notFound(Util.createResponse("Student not found", false));
            }
            JsonNode jsonObject = Json.toJson(student);
            return ok(Util.createResponse(jsonObject, true));
        }).orElse(internalServerError(Util.createResponse("Could not create data.", false)));
    }, ec.current());
}

4.3. 檢索操作

為了檢索一名學生，我們將學生的 ID 作為路徑參數傳遞到 GET 請求中，請求地址為 http://localhost:9000/:id。 這將觸發 檢索操作：

public CompletionStage<Result> retrieve(int id) {
    return supplyAsync(() -> {
        final Optional<Student> studentOptional = studentStore.getStudent(id);
        return studentOptional.map(student -> {
            JsonNode jsonObjects = Json.toJson(student);
            return ok(Util.createResponse(jsonObjects, true));
        }).orElse(notFound(Util.createResponse("Student with id:" + id + " not found", false)));
    }, ec.current());
}

4.4. 刪除操作

“刪除”操作映射到 http://localhost:9000/:id。 我們通過提供 id 來標識要刪除的記錄：

public CompletionStage<Result> delete(int id) {
    return supplyAsync(() -> {
        boolean status = studentStore.deleteStudent(id);
        if (!status) {
            return notFound(Util.createResponse("Student with id:" + id + " not found", false));
        }
        return ok(Util.createResponse("Student with id:" + id + " deleted", true));
    }, ec.current());
}

4.5. listStudents 操作

最後，listStudents 操作返回迄今為止存儲的所有學生的列表。它被映射到 http://localhost:9000/ 作為一個 GET 請求：

public CompletionStage<Result> listStudents() {
    return supplyAsync(() -> {
        Set<Student> result = studentStore.getAllStudents();
        ObjectMapper mapper = new ObjectMapper();
        JsonNode jsonData = mapper.convertValue(result, JsonNode.class);
        return ok(Util.createResponse(jsonData, true));
    }, ec.current());
}

5. 映射

在配置好我們的控制器動作之後，我們可以通過打開文件 student-api/conf/routes 並添加以下路由來映射它們：

GET     /                           controllers.StudentController.listStudents()
GET     /:id                        controllers.StudentController.retrieve(id:Int)
POST    /                           controllers.StudentController.create(request: Request)
PUT     /                           controllers.StudentController.update(request: Request)
DELETE  /:id                        controllers.StudentController.delete(id:Int)
GET     /assets/*file               controllers.Assets.versioned(path="/public", file: Asset)

必須始終存在/assets 端點才能下載靜態資源。

之後，我們完成了Student API 的構建。

要了解更多關於定義路由映射的信息，請訪問我們的“Play 應用程序中的路由”教程。

6. 測試

我們可以通過向 http://localhost:9000/ 發送請求來對我們的 API 進行測試，並添加適當的上下文。 從瀏覽器中運行基本路徑應會輸出：

{
     "isSuccessful":true,
     "body":[]
}

由於我們尚未添加任何記錄，我們可以看到身體為空。使用 curl，讓我們進行一些測試（或者我們可以使用像 Postman 這樣的 REST 客户端）。

讓我們打開一個終端窗口並執行 curl 命令以 添加一名學生：

curl -X POST -H "Content-Type: application/json" \
 -d '{"firstName":"John","lastName":"Baeldung","age": 18}' \
 http://localhost:9000/

這將返回新創建的學生。

{ 
    "isSuccessful":true,
    "body":{ 
        "firstName":"John",
        "lastName":"Baeldung",
        "age":18,
        "id":0
    }
}

在運行上述測試後，從瀏覽器中加載 http://localhost:9000 應該會得到：

{ 
    "isSuccessful":true,
    "body":[ 
        { 
            "firstName":"John",
            "lastName":"Baeldung",
            "age":18,
            "id":0
        }
    ]
}

id 屬性將在每次添加新記錄時遞增。

要刪除記錄，我們發送一個DELETE 請求：

curl -X DELETE http://localhost:9000/0
{ 
    "isSuccessful":true,
    "body":"Student with id:0 deleted"
}

在上述測試中，我們刪除了第一個測試中創建的記錄，現在我們來再次創建它，以便測試更新方法：

curl -X POST -H "Content-Type: application/json" \
-d '{"firstName":"John","lastName":"Baeldung","age": 18}' \
http://localhost:9000/
{ 
    "isSuccessful":true,
    "body":{ 
        "firstName":"John",
        "lastName":"Baeldung",
        "age":18,
        "id":0
    }
}

現在，讓我們通過將名字（first name）設置為“Andrew”和年齡設置為30來更新記錄：

curl -X PUT -H "Content-Type: application/json" \
-d '{"firstName":"Andrew","lastName":"Baeldung","age": 30,"id":0}' \
http://localhost:9000/
{ 
    "isSuccessful":true,
    "body":{ 
        "firstName":"Andrew",
        "lastName":"Baeldung",
        "age":30,
        "id":0
    }
}

上述測試演示了在更新記錄後，firstName 和 age 字段值的變化。

讓我們創建一些額外的佔位記錄，我們將添加兩個：John Doe 和 Sam Baeldung：

curl -X POST -H "Content-Type: application/json" \
-d '{"firstName":"John","lastName":"Doe","age": 18}' \
http://localhost:9000/

curl -X POST -H "Content-Type: application/json" \
-d '{"firstName":"Sam","lastName":"Baeldung","age": 25}' \
http://localhost:9000/

現在，我們來獲取所有記錄：

curl -X GET http://localhost:9000/
{ 
    "isSuccessful":true,
    "body":[ 
        { 
            "firstName":"Andrew",
            "lastName":"Baeldung",
            "age":30,
            "id":0
        },
        { 
            "firstName":"John",
            "lastName":"Doe",
            "age":18,
            "id":1
        },
        { 
            "firstName":"Sam",
            "lastName":"Baeldung",
            "age":25,
            "id":2
        }
    ]
}

通過以上測試，我們正在確認 listStudents 控制器方法的正確運行。

7. 結論

在本文中，我們展示瞭如何使用 Play 框架構建一個完整的 REST API。