@RestController @RequestMapping("/admin/blog/settings") @Api(tags = "Admin 博客设置模块")什么意思
时间: 2025-07-05 13:01:51 浏览: 2
### Spring Boot 中 `@RestController`、`@RequestMapping` 和 `@Api` 注解的含义及用法
#### @RestController 注解
`@RestController` 是 Spring 4 引入的一个组合注解,它结合了 `@Controller` 和 `@ResponseBody` 的功能。当使用 `@RestController` 注解时,所有的返回对象都会被自动转换为 JSON 或 XML 格式响应给客户端[^5]。
```java
@RestController
@RequestMapping("/api/admin")
public class AdminSettingsController {
@GetMapping("/settings")
public Map<String, Object> getBlogSettings() {
// 返回博客设置信息
return Collections.singletonMap("setting", "value");
}
}
```
#### @RequestMapping 注解
`@RequestMapping` 是用于映射 HTTP 请求到控制器方法的核心注解之一。它可以应用于类级别和方法级别。在类级别上定义基础路径,在方法级别上进一步细化具体的 URL 映射[^2]。
```java
@RequestMapping(value = "/admin/settings", method = RequestMethod.GET)
public ResponseEntity<Map<String, Object>> fetchAdminSettings() {
// 获取管理员设置逻辑
return new ResponseEntity<>(Collections.singletonMap("status", "success"), HttpStatus.OK);
}
```
#### @Api 注解 (Swagger/OpenAPI 文档生成工具中的注解)
`@Api` 注解通常来自 Swagger 或 OpenAPI 规范库,用来描述 REST API 接口的信息。这有助于自动生成文档以及提供交互式的 API 测试页面。需要注意的是,这不是 Spring 自带的注解,而是第三方库提供的扩展支持[^6]。
```java
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@Api(tags = "管理后台接口")
@RestController
@RequestMapping("/api/admin")
public class AdminSettingsController {
@ApiOperation(value = "获取博客设置", notes = "返回当前博客的所有配置项")
@GetMapping("/settings")
public Map<String, Object> getBlogSettings() {
// 返回博客设置信息
return Collections.singletonMap("setting", "value");
}
}
```
阅读全文
相关推荐


















