在现代API开发中,Swagger已成为构建和文档化RESTful API的强大工具。通过Swagger,开发者可以轻松定义接口规范并生成交互式文档,提升协作效率。以下是一些常用的Swagger参数及其用法,助你快速上手!
🔍 @Api:用于标记Controller类,描述整个模块的功能。例如:
```java
@Api(value = "用户管理模块", description = "提供用户注册与登录功能")
public class UserController { ... }
```
📝 @ApiOperation:为每个方法添加详细说明。
```java
@ApiOperation(value = "获取用户信息", notes = "根据ID查询用户详情")
@GetMapping("/{id}")
public User getUser(@PathVariable Long id) { ... }
```
🔗 @ApiParam:为请求参数添加注释,方便前端理解。
```java
@ApiOperation("新增用户")
@PostMapping
public User createUser(
@ApiParam(name = "username", value = "用户名", required = true) @RequestParam String username,
@ApiParam(name = "age", value = "年龄", required = false) @RequestParam(defaultValue = "18") Integer age) { ... }
```
🎉 使用这些参数后,Swagger UI界面会自动生成直观的API文档,帮助团队高效沟通!💪✨