SpringBoot中的Swagger2如何使用?

发布网友发布时间：2024-10-11 10:47

我来回答

共1个回答

热心网友时间：2024-10-31 00:34

背景

在之前我们已经在SpringBoot项目中集成好了Swagger2组件，同时已经可以成功访问了相关的swagger-ui.html，那么现在我们就来看一下Swagger的相关注解如何使用吧。

Swagger2的一些注解应用

先看一下官方的一些解释。

如果有兴趣，可以自行查看这里。

接下来我们来看一下具体的翻译信息：

注解名称功能描述@Api将类标记为Swagger资源。@ApiImplicitParam表示API操作中的单个参数。@ApiImplicitParams允许多个ApiImplicitParam对象列表的包装器。@ApiModel提供有关Swagger模型的其他信息。@ApiModelProperty添加和操作模型属性的数据。@ApiOperation描述针对特定路径的操作或通常的HTTP方法。@ApiParam为操作参数添加额外的元数据。@ApiResponse描述操作的可能响应。@ApiResponses允许多个ApiResponse对象列表的包装器。@Authorization声明用于资源或操作的授权方案。@AuthorizationScope描述OAuth2授权范围。@ResponseHeader表示可以作为响应的一部分提供的标头。

通过这些，我们就可以对具体的类进行修饰。

下面我们来看一下一个Demo。

@Api(tags="Demo演示接口")@Slf4j@RestController("demo")publicclassDemoController{@ApiOperation(value="@Demo演示接口1",notes="@Demo演示接口1")@GetMapping("/list/{name}")@ResponseBodypublicStringtest(@PathVariableStringname){log.info(name);System.out.println("test");returnname;}@ApiOperation(value="Demo演示接口2",notes="Demo演示接口2")@GetMapping("/test")@ResponseBodypublicStringtest1(){log.info("test");return"test1";}}