hosteons中文网

Swagger 通过注解的方式对接口进行描述，本节主要讲解一些常用生成接口文档的注解。

1. Api

@Api 用在类上，说明该类的作用。可以标记一个 Controller 类作为 Swagger 文档资源，使用方式代码如下所示。

@Api(tags={"用户接口"})
@RestController
public class UserController {

}

效果图如图 1 所示。

图 1  API 描述