首页 文章

使用Spring重新命名API

提问于
浏览
1

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

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

只更改说明,而不是名称 .

如此处所见

此外,我不确定默认名称和描述的来源,在添加API之前,名称似乎是从控制器名称派生的,但是描述;对我来说看起来很自然,人类就像硬编码的字符串一样大写 . 我对代码进行了搜索,但我无法找到这些字符串 . Swagger从哪里获得这些 Value ?

谢谢

1 回答

  • 1

    您要查找的属性是: tags . 因此,您可以避免按控制器名称进行分组 .

    来自 @Api tags 的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) .

相关问题