小编Paw*_*lis的帖子

如何从 Swagger UI 中的“架构”部分隐藏某些架构(OpenAPI 3、Spring Boot)

我正在使用 Springdoc 来记录在 Spring Boot 中制作的 REST API。\n我需要从Swagger UI 的Schemas部分隐藏一些模型/架构,这些模型/架构仅在 API 内部使用,因此无需在Schemas部分中显示它们。

\n

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

\n
@Getter\n@Setter\n@EqualsAndHashCode(callSuper = true)\n@AllArgsConstructor\n@NoArgsConstructor\n@Entity\n@Table\npublic class EventRole extends AbstractEntity implements Serializable {\n    @Column(nullable = false, length = 25)\n    private String descriptor;\n}\n
Run Code Online (Sandbox Code Playgroud)\n

上面显示的模型的超类:

\n
@Data\n@RequiredArgsConstructor\n@SuperBuilder\n@MappedSuperclass\npublic abstract class AbstractEntity {\n    @Id\n    @GeneratedValue(strategy = GenerationType.IDENTITY)\n    private Long id;\n\n    @CreationTimestamp\n    @Column(nullable = false, updatable = false)\n    private LocalDateTime creationDate;\n\n    @UpdateTimestamp\n    @Column(nullable = false)\n    private LocalDateTime modificationDate;\n}\n
Run Code Online (Sandbox Code Playgroud)\n

这些示例中的大多数注释都来自 JPA 或 Lombok。\n需要明确的是:在模式AbstractEntity部分 \xe2\x80\x93中不可见,我将其包含在此处以防万一。

\n …

rest swagger-ui spring-boot openapi springdoc

10
推荐指数
1
解决办法
8273
查看次数

标签 统计

openapi ×1

rest ×1

spring-boot ×1

springdoc ×1

swagger-ui ×1