swagger2隐藏自定义数据类型

在Swagger2中，可以使用`@ApiModel`和`@ApiModelProperty`注解来隐藏自定义数据类型。具体操作步骤如下：

1. 在自定义数据类型上使用`@ApiModel`注解，设置`hidden=true`，表示隐藏该数据类型。

@ApiModel(hidden=true)
public class CustomType {
    ...
}

2. 在需要隐藏该数据类型的API方法中，使用`@ApiModelProperty`注解，设置`hidden=true`，表示隐藏该数据类型在API文档中的显示。

@ApiOperation("API方法")
@ApiResponses(value = {@ApiResponse(code = 200, message = "OK")})
@GetMapping("/api")
public ResponseEntity<?> apiMethod() {
    ...
}
@ApiModel
public class ResponseDTO {
    @ApiModelProperty(hidden = true)
    private CustomType customType;
    ...
}

这样，在生成的API文档中，该自定义数据类型就会被隐藏起来，不会在API文档中显示。

相关问题

swagger2隐藏自定义数据类型失效

如果在Swagger2中使用`@ApiModel`和`@ApiModelProperty`注解设置隐藏自定义数据类型无效，可能是以下几个原因：

1. 没有配置Swagger2的Docket

在配置Swagger2时，需要创建Docket对象并配置，如果没有配置Docket或者配置不正确，可能导致注解失效。可以参考以下示例：

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger API")
                .version("1.0")
                .build();
    }
}

2. 注解配置错误

在使用`@ApiModel`和`@ApiModelProperty`注解时，需要注意注解的使用方式和属性设置是否正确。可以参考上面的示例，正确地使用注解。

3. 缓存问题

有时候，Swagger2可能会缓存之前的API文档，导致新的注解设置无效。可以尝试清除Swagger2的缓存，重新生成API文档。

如果以上方法都无法解决问题，可以尝试重启应用程序或者查看Swagger2的日志，找到原因并解决。

swagger3 自定义注解

在Swagger3中，可以通过自定义注解来进一步定制和扩展API文档的展示和功能。自定义注解允许开发者添加额外的信息，以便更好地描述和解释API接口。以下是Swagger3中常用的自定义注解：

1. @Api：用于描述整个Controller或接口的基本信息，包括接口的名称、描述等。
2. @ApiOperation：用于描述具体的API接口，包括接口的名称、描述、请求方法等。
3. @ApiParam：用于描述接口的参数，包括参数名称、描述、是否必须等信息。
4. @ApiModel：用于描述实体类或DTO的基本信息，包括类的名称、描述等。
5. @ApiModelProperty：用于描述实体类或DTO的属性，包括属性的名称、描述、示例值等。

通过使用这些自定义注解，开发者可以清晰地定义和展示API接口的各种信息，方便其他开发人员理解和使用接口。同时，Swagger3还提供了丰富的UI界面，可以直观地展示接口的参数和返回结果，并提供接口测试的功能，类似于Postman工具。这样开发人员可以方便地测试和调试接口，提高开发效率。<span class="em">1</span><span class="em">2</span><span class="em">3</span>
#### 引用[.reference_title]
- *1* [Springboot整合Swagger3全注解配置（springdoc-openapi-ui）](https://blog.csdn.net/weixin_44768189/article/details/115055784)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"]
- *2* *3* [Swagger2注解的介绍](https://blog.csdn.net/weixin_33883178/article/details/92424879)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"]
[ .reference_list ]