Tli*_*ink 5 swagger spring-boot springfox
据我了解,在 Spring 中使用 Swagger 记录 API 时,我可以通过添加注释来更改 API 的描述@Api,但是当我按如下方式添加时
@Api(value= "NEW_NAME", description="NEW_DESCRIPTION")
Run Code Online (Sandbox Code Playgroud)
仅更改了描述,未更改名称。
如这里所见
此外,我不确定默认名称和描述来自哪里,在添加 API 之前,名称似乎是从控制器名称派生的,但描述;对我来说,这看起来很自然,很人性化,几乎就像带有大写字母和所有内容的硬编码字符串。我对代码进行了搜索,但找不到这些字符串。Swagger 从哪里获取这些值?
谢谢
您正在寻找的属性是:tags。因此您可以避免按控制器名称分组。
来自 Javadoc @Api tags:
标签可用于按资源或任何其他限定符对操作进行逻辑分组。
例如:
@Api(value = "/customers", tags = "customers", description = "Manage Customer")
Run Code Online (Sandbox Code Playgroud)
默认情况下,Springfox 创建名称为 as {controller-name}-controller、描述为 as 的API {Controller Name} Controller(参见如何更改 Swagger Spring 中的默认控制器名称)。
| 归档时间: |
|
| 查看次数: |
7982 次 |
| 最近记录: |