使用 Spring 大摇大摆地重命名 API答案

【问题标题】：Renaming APIs in swagger with Spring使用 Spring 大摇大摆地重命名 API
【发布时间】：2019-05-05 00:35:59
【问题描述】：

我了解在 Spring 中使用 Swagger 记录 API 时，我可以通过添加 @Api 注释来更改 API 的描述，但是当我按如下方式添加时

@Api(value= "NEW_NAME", description="NEW_DESCRIPTION")

只更改了描述，没有更改名称。

在这里看到

此外，我不确定默认名称和描述来自哪里，在添加API之前，名称似乎是从控制器名称派生的，但是描述；对我来说，这看起来很自然和人性化，几乎就像带有大写字母的硬编码字符串。我对代码进行了搜索，但找不到那些字符串。 Swagger 从哪里获得这些值？

谢谢

【问题讨论】：

【解决方案1】：

您要查找的属性是：tags。所以你可以避免按控制器名称分组。

来自@Apitags的Javadoc：

标签可用于按资源或任何其他限定符对操作进行逻辑分组。

例如：

@Api(value = "/customers", tags = "customers", description = "Manage Customer")

默认情况下，Springfox 创建 API 名称为 {controller-name}-controller，描述为 {Controller Name} Controller（参见 How to change the default Controller Name in Swagger Spring ）。

【讨论】：

【解决方案2】：

看来目前的做法是：

@Api(description = "Manage cars", tags = { "Cars" })

【讨论】：