Swagger中常用注解
目录
- Swagger 常用注解详解（SpringBoot 接口文档神器）
- 一、前言
- 二、Swagger 核心依赖（SpringBoot）
- 三、Swagger 最常用注解（必背）
- 1. @Api —— 用在**Controller 类**上
- 2. @ApiOperation —— 用在**接口方法**上
- 3. @ApiParam —— 用在**单个参数**前
- 4. @ApiModel —— 用在**实体类/DTO**上
- 5. @ApiModelProperty —— 用在**实体字段**上
- 6. @ApiIgnore —— 忽略接口/字段
- 7. @ApiImplicitParam / @ApiImplicitParams
- 8. @ApiResponses / @ApiResponse
- 四、完整示例（Controller + DTO）
- 1. Controller
- 2. DTO
- 五、Swagger UI 访问地址
- 六、总结
- 优化亮点
Swagger 常用注解详解（SpringBoot 接口文档神器）
一、前言
在前后端分离开发中，接口文档是前后端沟通的核心。
Swagger可以通过注解自动生成接口文档，支持在线调试、自动同步更新，彻底告别手写文档。
本文整理Swagger 最常用注解，包含 Controller 层、参数、实体类全套用法，企业开发直接照搬使用。
二、Swagger 核心依赖（SpringBoot）
<!-- Swagger3 (OpenAPI 3.0) 推荐 --><dependency><groupId