是否可以使用Swagger Java注解对API端点进行路径式文档化？

falq053o 于 2023-02-18 发布在 Java

关注(0)|答案(1)|浏览(113)

比方说，我有一个类Person，根据端点的不同，它的firstName要么是必需的，要么是不必需的，有没有办法用Java中的Swagger OpenAPI文档标记来实现这一点？
我在想象，如果可能的话，它可能看起来有点像这样：

public class Person {
    @Path("/endpoint1", required = true)
    @Path("/endpoint2", required = false)
    private String firstName;
}

1条答案

您需要两个类-一个类的firstName属性是必需的，另一个类的firstName属性是可选的。为了减少代码重复，您可以定义一个包含除firstName之外的所有属性的基类，并从此基类继承其他两个Person类。