swagger常用注释

Swagger 常用的注释有以下几种：

1. @Api：用于类上，表示标识这个类是 Swagger 的资源。
2. @ApiOperation：用于方法上，表示一个 HTTP 请求的操作。
3. @ApiParam：用于参数上，表示对参数的描述。
4. @ApiModel：用于类上，表示对类进行说明，用于参数用实体类接收时。
5. @ApiModelProperty：用于属性上，表示对 Model 属性的说明。
6. @ApiIgnore：用于类或者方法上，表示这个类或者方法不被 Swagger 生成 API 文档。
7. @ApiImplicitParam：用于方法上，表示单独的请求参数。
8. @ApiImplicitParams：用于方法上，包含多个 @ApiImplicitParam。
9. @ApiResponse：用于方法上，表示对响应的描述。
10. @ApiResponses：用于方法上，包含多个 @ApiResponse。
11. @ApiError：用于方法上，表示对错误的说明。
12. @ApiErrors：用于方法上，包含多个 @ApiError。

以上就是 Swagger 常用的注释，可以帮助我们更好地使用 Swagger 生成 API 文档。

相关问题

swagger.v3 类字段注释的注解

Swagger是一个流行的API设计工具，它提供了一个基于JSON的规范，帮助开发者描述RESTful API。在Swagger V3中，用于注解类字段以生成文档的是`@ApiModel`, `@ApiModelProperty`以及相关的注解。

1. **@ApiModel**: 这个注解用于标记一个Java实体类，表示这是一个API模型，可用于输入、输出或其他数据交换。例如：

   @ApiModel(value = "User")
   public class User {
       // ...
       @ApiModelProperty(name = "firstName", value = "用户的第一名字")
       private String firstName;
       // ...
   }

2. **@ApiModelProperty**: 这个注解用于详细说明单个字段，如字段名称、描述、数据类型、必填等。例如：

   private int id @ApiModelProperty(name = "id", description = "用户的唯一标识", required = true);

其他一些常用的注解还包括：
- `@JsonProperty`: 对应JSON属性名，与`@ApiModelProperty`配合使用可以指定在生成文档中的JSON键。
- `@ApiModelProperty(hidden=true)`: 隐藏某个字段，不会出现在生成的文档中。

springboot 禁用swagger2

在使用SpringBoot开发Web应用过程中，swagger2是一种非常常用的工具，它能够自动生成API文档，使我们的开发更加便捷。但有时也许我们需要禁用swagger2，这时我们需要采取以下步骤：

第一步，从pom.xml文件中删除swagger2的依赖项，即注释掉下面的代码：

<!-- swagger2 -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.8.0</version>
</dependency>
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.8.0</version>
</dependency>

第二步，进入SpringBoot的启动类，找到`@EnableSwagger2`注解，并将它注释掉或者删除掉。

第三步，如果我们需要更彻底地禁用swagger2，我们还需要在配置文件（application.yml或application.properties）中添加下面的配置：

springfox.documentation.swagger.v2.enabled: false

通过这些步骤，我们就可以很方便地禁用swagger2，使得项目中不再有API文档的展示。