API描述未在Swagger UI中显示

时间:2015-10-23 09:45:26

标签: java spring api spring-mvc swagger

我想用Swagger和Spring MVC记录REST API,

我在Swagger UI中探索/ api-docs网址

就像下图一样。

enter image description here

enter image description here

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

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

ServletConifg

.......
@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"}

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

我将非常感谢您提供的任何帮助。

2 个答案:

答案 0 :(得分:2)

我不确定Spring-MVC对Swagger的看法,但我希望你能用my research on Swagger 1.5来解决你的情况。我使用了您的问题(并分享了您的共享图片)来构建我的问题,因此我确信它可以为您提供部分帮助。

答案 1 :(得分:1)

关于第一个问题,因为你使用了错误的swagger-core依赖。尝试使用以下依赖项com.wordnik:swagger-annotations:1.3.11(gradle artifact representation)

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