二. 設置開發環境。

在開始構建 REST API 之前，需準備以下環境：

1. 安裝 Java 開發工具包（JDK）

2. 集成開發環境（IDE）

3. 構建工具

三. 創建 Spring Boot 項目。

使用 Spring Initializr 快速生成項目：

1. 生成 Spring Boot 項目

  1. 訪問 Spring Initializr。

  2. 配置：

  3. 添加依賴：

  4. 點擊 Generate 下載 .zip 文件。

2. 導入項目到 IDE

  1. 解壓 .zip 文件。
  2. 在 IDE 中以 Maven 項目導入。
  3. IDE 自動下載依賴并設置項目結構。

四. 理解 Spring Boot 項目結構。

典型項目結構如下：

src/main/java/com/example/restapi/

├── RestApiApplication.java       // 主應用程序入口

├── model/                        // 實體類

├── repository/                   // 數據庫交互接口

├── service/                      // 業務邏輯層

├── controller/                   // 控制器層

└── resources/application.properties // 配置文件

五. 構建 REST API。

以管理 Product 實體為例：

1. 創建模型（Model）

package com.example.restapi.model;

import jakarta.persistence.*;

@Entity
public class Product {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private double price;

    // Getters and Setters
}

2. 創建存儲庫（Repository）

package com.example.restapi.repository;

import com.example.restapi.model.Product;
import org.springframework.data.jpa.repository.JpaRepository;

public interface ProductRepository extends JpaRepository < Product, Long > {
}

3. 創建服務層（Service）

package com.example.restapi.service;

import com.example.restapi.model.Product;
import com.example.restapi.repository.ProductRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;
import java.util.Optional;

@Service
public class ProductService {
    @Autowired
    private ProductRepository productRepository;

    public List < Product > getAllProducts() {
        return productRepository.findAll();
    }

    public Optional < Product > getProductById(Long id) {
        return productRepository.findById(id);
    }

    public Product createProduct(Product product) {
        return productRepository.save(product);
    }

    public Product updateProduct(Long id, Product productDetails) {
        Product product = productRepository.findById(id)
                .orElseThrow(() - > new RuntimeException("Product not found"));
        product.setName(productDetails.getName());
        product.setPrice(productDetails.getPrice());
        return productRepository.save(product);
    }

    public void deleteProduct(Long id) {
        Product product = productRepository.findById(id)
                .orElseThrow(() - > new RuntimeException("Product not found"));
        productRepository.delete(product);
    }
}

4. 創建控制器（Controller）

package com.example.restapi.controller;

import com.example.restapi.model.Product;
import com.example.restapi.service.ProductService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.List;
import java.util.Optional;

@RestController
@RequestMapping("/api/products")
public class ProductController {
    @Autowired
    private ProductService productService;

    @GetMapping
    public List < Product > getAllProducts() {
        return productService.getAllProducts();
    }

    @GetMapping("/{id}")
    public ResponseEntity < Product > getProductById(@PathVariable Long id) {
        Optional < Product > product = productService.getProductById(id);
        return product.map(ResponseEntity::ok)
                .orElseGet(() - > ResponseEntity.notFound().build());
    }

    @PostMapping
    public Product createProduct(@RequestBody Product product) {
        return productService.createProduct(product);
    }

    @PutMapping("/{id}")
    public ResponseEntity < Product > updateProduct(@PathVariable Long id, @RequestBody Product productDetails) {
        Product updatedProduct = productService.updateProduct(id, productDetails);
        return ResponseEntity.ok(updatedProduct);
    }

    @DeleteMapping("/{id}")
    public ResponseEntity < Void > deleteProduct(@PathVariable Long id) {
        productService.deleteProduct(id);
        return ResponseEntity.noContent().build();
    }
}

六. 處理 HTTP 方法。

Spring Boot 提供注解處理常用 HTTP 請求：

七. 錯誤處理。

通過全局異常處理器提供一致的錯誤響應：

package com.example.restapi.exception;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.context.request.WebRequest;

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(RuntimeException.class)
    public ResponseEntity < String > handleRuntimeException(RuntimeException ex, WebRequest request) {
        return new ResponseEntity < > (ex.getMessage(), HttpStatus.NOT_FOUND);
    }
}

八. 部署 REST API。

1. 構建項目

mvn clean package

2. 運行 JAR 文件

java -jar target/restapi-0.0.1-SNAPSHOT.jar

3. 部署到云平臺

九. 總結。

通過本指南，您掌握了使用 Java Spring Boot 構建 REST API 的核心步驟：

Spring Boot 提供了強大的生態系統和社區支持，使其成為構建企業級 RESTful 服務的理想選擇。

原文鏈接

Index.dev: Build REST API with Java Spring Boot

上一篇：

Python 與 AWS Lambda 構建高效無服務器 REST API 實戰指南
 最后一篇
#你可能也喜歡這些API文章!

我們有何不同？

API服務商零注冊

多API并行試用

數據驅動選型，提升決策效率

查看全部API→
??

熱門場景實測，選對API

#AI文本生成大模型API

對比大模型API的內容創意新穎性、情感共鳴力、商業轉化潛力

25個渠道
一鍵對比試用API 限時免費

#AI深度推理大模型API

對比大模型API的邏輯推理準確性、分析深度、可視化建議合理性

10個渠道
一鍵對比試用API 限時免費