如何从Swagger UI（OpenAPI 3，Spring Boot）中的“模式”部分隐藏某些模式

Question

我正在使用Springdoc来记录我在Spring Boot中制作的REST API。我需要从Swagger UI的模式部分隐藏一些模型/模式，这些模型/模式只在应用编程接口内部使用，所以没有必要在模式部分显示它们。

这是我试图隐藏的模型之一：

@Getter
@Setter
@EqualsAndHashCode(callSuper = true)
@AllArgsConstructor
@NoArgsConstructor
@Entity
@Table
public class EventRole extends AbstractEntity implements Serializable {
    @Column(nullable = false, length = 25)
    private String descriptor;
}

上图所示模型的超类：

@Data
@RequiredArgsConstructor
@SuperBuilder
@MappedSuperclass
public abstract class AbstractEntity {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @CreationTimestamp
    @Column(nullable = false, updatable = false)
    private LocalDateTime creationDate;

    @UpdateTimestamp
    @Column(nullable = false)
    private LocalDateTime modificationDate;
}

这些示例中的大多数注释都来自JPA或Lombok。需要明确的是：AbstractEntity在Schemas部分不可见–我在这里包括它只是为了以防万一。

到目前为止，我已经尝试过：

• 对我要隐藏的类使用@Hidden注释
• 在这些类上使用@Schema（hidden=true）
• 添加SpringDocUtils。getConfig（）。addAnnotationsToIgnore（EventRole.class、AbstractEntity.class） 到我的OpenAPI bean配置

我还测试了控制器方法上的@Hidden，它工作正常。@模式（隐藏=true）正确隐藏模型属性。不出所料，它们都没有隐藏整个模型。我是否使用了错误的注释，或者可能有其他原因导致这不起作用？我是OpenAPI 3. x和Springdoc的新手，很可能我误解了什么。




Answer 1

我花了几个小时才找到解决办法

在摘要设置中使用ignoredParameterTypes

这个有效！

Docket()...
.ignoredParameterTypes(ModleName.class)