@ApiOperation?注解并非 Spring Boot 自帶的注解，而是來自 Swagger 框架，Swagger 是一個規范且完整的框架，用于生成、描述、調用和可視化 RESTful 風格的 Web 服務，而?@ApiOperation?主要用于為 API 接口的操作添加描述信息。以下為你詳細介紹：

依賴引入

如果你使用的是 Maven 項目，需要在?pom.xml?中添加 Swagger 的依賴：

<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version>
</dependency>

注解作用

@ApiOperation?注解通常用于控制器（Controller）的方法上，為該方法所代表的 API 操作提供詳細的描述信息，這些信息會在 Swagger 生成的 API 文檔中顯示，方便開發人員和測試人員理解接口的用途和功能。

常用屬性

• value：用于簡要描述 API 操作的功能，是該注解的默認屬性，通常是一個簡短的句子，概括接口的主要作用。
• notes：提供更詳細的說明信息，可包含接口的使用注意事項、業務邏輯說明等內容。
• response：指定該 API 操作的返回類型，Swagger 會根據此類型生成返回參數的示例和描述。
• httpMethod：指定該 API 操作使用的 HTTP 方法，如 "GET"、"POST"、"PUT"、"DELETE" 等。

使用示例

以下是一個簡單的 Spring Boot 控制器示例，展示了?@ApiOperation?注解的使用：

java

import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/api")
public class UserController {@ApiOperation(value = "獲取用戶信息", notes = "根據用戶 ID 獲取用戶的詳細信息", httpMethod = "GET")@GetMapping("/users/{id}")public String getUserInfo() {return "User information";}
}

代碼解釋

• 在上述示例中，@ApiOperation?注解應用于?getUserInfo?方法上。
• value?屬性設置為 "獲取用戶信息"，簡要說明了該接口的功能。
• notes?屬性提供了更詳細的說明，即根據用戶 ID 獲取用戶的詳細信息。
• httpMethod?屬性指定了該接口使用的 HTTP 方法為 GET。

查看 API 文檔

在添加了 Swagger 依賴和?@ApiOperation?注解后，啟動 Spring Boot 應用程序，訪問?http://localhost:8080/swagger-ui.html（端口號根據實際情況修改），即可看到生成的 API 文檔，其中包含了使用?@ApiOperation?注解添加的描述信息。

需要注意的是，Springfox Swagger 2 在 Spring Boot 3.x 中不再被支持，如果你使用的是 Spring Boot 3.x，可以考慮使用 Springdoc OpenAPI 來替代。