前端 Swagger 注解使用指南：快速构建 API 文档

前端 Swagger 可以使用注解的方式来描述 API 接口的信息。这些注解可以帮助开发者快速地构建和维护 API 文档，提高开发效率。

在前端 Swagger 中，常用的注解有以下几种：

1. '@api'：用于描述 API 接口的基本信息，包括接口名称、请求方式、请求参数、返回值等。

2. '@param'：用于描述请求参数的信息，包括参数名称、参数类型、参数说明等。

3. '@returns'：用于描述返回值的信息，包括返回值类型、返回值说明等。

4. '@description'：用于描述接口的详细信息，包括接口功能、使用方法等。

使用注解的方式，可以让开发者在编写代码时直接添加注解，而不需要再进行繁琐的文档编写工作。同时，注解也能够提高文档的准确性和完整性，保障 API 接口的质量。