Swagger UI 中未显示 API 描述答案

【问题标题】：API description not show in Swagger UISwagger UI 中未显示 API 描述
【发布时间】：2015-10-23 09:45:26
【问题描述】：

我想用 Swagger 和 Spring MVC 记录一个 REST API，

我在 Swagger UI 中探索 /api-docs URL

如下图。

有人可以帮我解决两个问题吗？

1. I don't know why the description isn't display.
2. how can I show all API in same group

SwaggerConfig.java

@Configuration
@EnableSwagger
public class SwaggerConfig {
  private SpringSwaggerConfig springSwaggerConfig;

  @Autowired
  public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig){
      this.springSwaggerConfig = springSwaggerConfig;
  }

  @Bean
  public SwaggerSpringMvcPlugin customImplementation(){
    return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
      .apiInfo(apiInfo())
      .includePatterns(".*/rest.*");
    }

  private ApiInfo apiInfo(){
      ApiInfo apiInfo = new ApiInfo(
      "API description", "API for me", 
      "API terms of service", 
      "ageehuang@gmail.com", "", ""
      );
      return apiInfo;
    }

pom.xml

jackson-annotations 2.2.3
jackson-databind 2.2.3
jackson-core 2.2.3
guava 14.0
swagger-springmvc 1.0.2
swagger-core_2.10 1.3.7

Servlet配置

.......
@Configuration
@ComponentScan(basePackages = {"config.swagger"})
public class ServletConfig{ 
.......

Controller.java

@Controller
@RequestMapping(value = "/rest/v1")
@Api(value = "CounponController" ,description="SCCCCCC")
public class CouponController {
........

http://localhost:8080/coupon/api-docs

{"apiVersion":"1.0","apis":[{"description":"SCCCCCC","path":"/default/counponcontroller","position":0},{"description":"Coupon Order Controller","path":"/default/coupon-order-controller","position":0},{"description":"Data Controller","path":"/default/data-controller","position":0},{"description":"Ep Controller","path":"/default/ep-controller","position":0}],"authorizations":{},"info":{"contact":"ageehuang@eztravel.com.tw","description":"API for Ez-Conpon","license":"","licenseUrl":"","termsOfServiceUrl":"EzTravel API terms of service","title":"EzTravel"},"swaggerVersion":"1.2"}

如果需要任何信息，请告诉我

如果您能提供任何帮助，我将不胜感激。

【问题讨论】：

您对此有什么解决方案吗？我也面临同样的问题

标签： java spring api spring-mvc swagger

【解决方案1】：

我不确定 Spring-MVC 对 Swagger 的看法，但我希望您可以使用 my research on Swagger 1.5 来阐明您的情况。我使用您的问题（并分享了您的共享图像）来构建我的问题，因此我相信它可以为您提供部分帮助。

【讨论】：

【解决方案2】：

关于第一个问题，因为您使用了错误的 swagger-core 依赖项。尝试使用以下依赖com.wordnik:swagger-annotations:1.3.11（gradle 工件表示）

稍后会详细介绍第二个问题

【讨论】：

我面临同样的问题。我已经尝试添加与您提到的相同的依赖项，但我的问题没有解决。