用 Spring 大摇大摆地重命名 API
Renaming APIs in swagger with Spring
我知道在 Spring 中使用 Swagger 记录 API 时,我可以通过添加 @Api
注释来更改 API 的描述,但是当我添加如下
@Api(value= "NEW_NAME", description="NEW_DESCRIPTION")
只更改了描述,没有更改名称。
如此处所示
此外,我不确定默认名称和描述从何而来,在添加API之前,名称似乎来自控制器名称,但描述;在我看来,这看起来自然而人性化,几乎就像带有大写字母的硬编码字符串。
我 运行 搜索了代码,但找不到这些字符串。 Swagger 从哪里获得这些值?
谢谢
您要查找的属性是:tags
。所以你可以避免按控制器名称分组。
来自 @Api
的 Javadoc tags
:
Tags can be used for logical grouping of operations by resources or any other qualifier.
例如:
@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 )。
看来目前的做法是:
@Api(description = "Manage cars", tags = { "Cars" })
我知道在 Spring 中使用 Swagger 记录 API 时,我可以通过添加 @Api
注释来更改 API 的描述,但是当我添加如下
@Api(value= "NEW_NAME", description="NEW_DESCRIPTION")
只更改了描述,没有更改名称。
如此处所示
此外,我不确定默认名称和描述从何而来,在添加API之前,名称似乎来自控制器名称,但描述;在我看来,这看起来自然而人性化,几乎就像带有大写字母的硬编码字符串。 我 运行 搜索了代码,但找不到这些字符串。 Swagger 从哪里获得这些值?
谢谢
您要查找的属性是:tags
。所以你可以避免按控制器名称分组。
来自 @Api
的 Javadoc tags
:
Tags can be used for logical grouping of operations by resources or any other qualifier.
例如:
@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 )。
看来目前的做法是:
@Api(description = "Manage cars", tags = { "Cars" })