使用 Java 建立 REST API：您是 Java 初學者嗎？

嘿，Dev.to 社群！ ？

歡迎來到初學者友善的指南在 Java 中建立 REST API。無論您是剛入門還是想鞏固理解，本文都將引導您了解基礎知識，提供易於理解的解釋和實際範例。

什麼是 REST API？

REST（表述性狀態傳輸）API 是應用程式透過 HTTP 進行通訊的一種流行方式。它們允許不同的軟體元件相互交互，發送請求和接收回應，例如請求資料或提交資訊。

為什麼選擇Java？

Java 是一種強大的、物件導向的程式語言，廣泛應用於企業應用程式。它對使用 Spring Boot.

等框架構建可擴展且安全的 REST API 提供了出色的支持

入門：您需要的工具

在深入研究程式碼之前，讓我們確保您擁有正確的工具：

• Java 開發工具包 (JDK)：確保您已安裝 JDK。
• IDE：您可以使用 IntelliJ IDEA、Eclipse 或 VS Code。
• Maven 或 Gradle：用於依賴管理。
• Spring Boot：一個 Java 框架，可簡化 Web 應用程式的創建，包括 RESTful 服務。

第 1 步：設定您的項目

您可以使用 Spring Initializr 建立新的 Spring Boot 項目，也可以使用 IDE 的整合項目建立工具。

專案設定完畢後，在 pom.xml 中加入必要的依賴項（如果使用 Maven）：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

這帶來了建立 RESTful API 所需的一切。

步驟 2： 建立一個簡單的 REST 控制器

讓我們直接開始建立我們的第一個 REST 端點。在 Spring Boot 中，我們使用 @RestController 註解將類別標記為 REST API 的控制器。它的外觀如下：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, Dev.to!";
    }
}

在此範例中：

• @RestController 使該類別成為 REST API 控制器。
• @GetMapping("/hello") 將 HTTP GET 請求綁定到 /hello 端點。
• sayHello() 方法傳回一個簡單的「Hello, Dev.to!」訊息作為回應。

第 3 步：運行應用程式

要執行 Spring Boot 應用程序，請導航至專案根目錄並執行：

mvn spring-boot:run

現在，打開瀏覽器並導航到 http://localhost:8080/hello。您應該會看到訊息「Hello, Dev.to!」

步驟 4：新增更多端點

讓我們新增一個傳回使用者清單的端點。首先，建立一個 User 類別：

public class User {
    private String name;
    private String email;

    public User(String name, String email) {
        this.name = name;
        this.email = email;
    }

    // Getters and Setters
}

然後，修改控制器以傳回使用者清單：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.Arrays;
import java.util.List;

@RestController
public class UserController {

    @GetMapping("/users")
    public List<User> getUsers() {
        return Arrays.asList(
            new User("Alice", "alice@example.com"),
            new User("Bob", "bob@example.com")
        );
    }
}

第 5 步：處理 POST 請求

為了處理 POST 請求，我們使用 @PostMapping。這是我們透過 POST 接受用戶資料並返回創建的用戶的範例：

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @PostMapping("/users")
    public User createUser(@RequestBody User user) {
        // Normally, you'd save the user to a database here
        return user;
    }
}

使用此方法，您可以向 /users 發送帶有 JSON 正文的 POST 請求，它將傳回已建立的使用者。

步驟6：使用Postman或curl進行測試

要測試POST端點，可以使用Postman或curl：

curl -X POST http://localhost:8080/users -H "Content-Type: application/json" -d '{"name":"Charlie","email":"charlie@example.com"}'

這將傳回建立使用者的 JSON 回應。

接下來是什麼？

從這裡，您可以探索：

• 新增驗證：使用 @Valid 和 @NotNull 等註解驗證傳入資料。
• 連接資料庫：使用JPA將資料儲存在關聯式資料庫中。
• 錯誤處理：使用@ControllerAdvice自訂API的錯誤回應。

來聊聊吧！ ？

我很想聽聽你的消息！請隨意提出問題、分享回饋，甚至在評論部分展示您所建立的內容。另外，不要忘記與任何可能覺得有用的人分享這篇文章！

感謝您的閱讀，祝您編碼愉快！ ？

以上是使用 Java 建立 REST API：您是 Java 初學者嗎？的詳細內容。更多資訊請關注PHP中文網其他相關文章！