如何在Swagger 1.5.20中为API控制器添加描述？

Question

我正试图提供格式化的描述给一个在大摇大摆的控制器。但是，我找不到任何可以启用它的注释。当前看起来如下所示：

@Api(tags = {"Change timezone"})

然而，我想提供有意义的描述。不推荐使用带有@api的description参数。

Answer 1

看来，这种贬低是有漏洞的。该功能已被弃用，但没有其他注释替代该功能。

目前看来，您只能以编程方式添加描述

@Bean public Docket commonDocketConfig() { 

 return new Docket(DocumentationType.SWAGGER_2) .select() 
       .apis(RequestHandlerSelectors.basePackage("com.company")) 
       .paths(PathSelectors.any()) 
       .build() .apiInfo(apiEndPointsInfo()) 
       .tags(new Tag("Change timezone", "your description")); }

可以在此跟踪问题

@API描述已弃用，没有任何替代方案

您也可以尝试使用

@Api(tags = {"Change timezone"})
@SwaggerDefinition(tags = {
        @Tag(name = "hange timezone", description = "your Description")
})
public class YourController {
}

但是，这个注释已经有一个未正确运行的缺陷@swagerdefinition bug

Answer 2

既然你的操作看起来像是PUT操作，那就试试这样做吧。你也可以这样写：

@OA(
    @PUT(
        tags = {"Change timezone"},
        description = "Your description here",
        etc...
    )
)

这里是我拍摄图片的链接:https://github.com/swagger-api/swagger-core/wiki/swagger-2.x---annotations#operation尝试在这里阅读更多内容。