Spring数据支架的摆动器2或3

Question

我有一个使用SpringDataREST的SpringBoot应用程序。我在使用swagger提供一个通俗易懂的API文档时遇到了一个问题。我试过SpringFox和springdoc，但都有问题

1. 春狐：

• 我不能改变一个仓库的标签名称，只有描述
• 不支持投影
• 还不支持openAPI3（这其实问题不大）

• 我无法更改标记名称和描述（@tag对回购不起作用）

还有更好的办法吗？我喜欢SpringFox不提供多个标记，而且自动生成的标记名更好，例如Books实体而不是Books实体控制器。但最好是对其进行定制或找到更好的替代方案。

Answer 1

斯普林多克

我无法更改标记名和描述（@tag对repos不起作用）

和

同一回购协议有3个标签

你可以自定义它。在控制器类级别使用以下内容。

@Tag(name = "Name of the Tag", description = "Description of the tag")

或

@Tags(value = {
    // Multiple @Tag annotations separated by comma ,
})

或者在方法级别执行以下操作。

@Operation(tags = {"Tag 1", "Tag 2"})

记得：

• @Tag将覆盖特定类的操作级别标记。
• 类级别标签只能有1个值。

因此，如果您需要一个控制器具有多个标记，则应将其隔离在不同的类中，该类在类级别上没有@Tag。

不支持预测

我从未使用过投影。我通常使用@JsonIgnore来消除那些不需要的，但这取决于您的用例。

如果要隐藏架构中的内容，请使用以下方法

@Schema(description = "Example POJO to demonstrate the hidden attribute")
class Example {
    ...
    @Schema(hidden = true)    // <--- Will be hidden from the Swagger UI completely 
    String exampleId;
    ...
}

希望有帮助。对任何澄清发表评论。

Answer 2

我建议SpringRest，不要大摇大摆。SpringREST文档是测试驱动的，以确保API文档始终与API同步。Andy的演讲更多地解释了为什么SpringREST文档比Swagger更适合API文档。

你可以找到官方的简单指南和更多的例子。

我的Github项目使用它。您可以克隆存储库并查看生成的文档HTML/sga booking/index。html。相关的SpringREST文档文件包括

• FLTAPIDO文件。java
• flts。adoc
• 预订文件。java
• 预订。阿多克

如果你觉得我的GITHUB是有用的，考虑给它一个明星。