Swagger UI是否支持@PathVariable绑定?

时间:2015-02-23 02:00:21

标签: spring spring-boot swagger swagger-ui

目前,我正在测试Swagger UI,以获取绑定" id"的 GET 请求。路径变量到数据对象," id"的数据类型field是Model,而不是Long。

例如,这是RestController中的方法:

@RequestMapping(value = "/{id}", method = GET)
    public AwardVO getAwardById(@PathVariable("id") Award award) {
        LOG.info("inside the get award method: "+award);
        if (award == null) {
            throw new AwardNotFoundException();
        }

        return new AwardVO(award);
    }

以下是生成的文档:

swagger ui example

因此,当我将Long传递给输入字段时,我没有收到所需的记录。是否在Swagger中支持这种类型的绑定,或者我是否只需要对记录进行查找并将PathVariable作为Long传递?

Swagger版本:编译" com.mangofactory:swagger-springmvc:0.9.5"

SwaggerConfig:

@Configuration
@EnableSwagger
public class SwaggerConfig extends WebMvcConfigurerAdapter {

    private SpringSwaggerConfig springSwaggerConfig;

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

    @Bean
    public SwaggerSpringMvcPlugin customImplementation() {
        return new SwaggerSpringMvcPlugin(this.springSwaggerConfig).apiInfo(
                apiInfo())
                .genericModelSubstitutes(ResponseEntity.class)
                .includePatterns("/v1/.*", "/register/.*");
    }

    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfo("API", "API",
                "API terms of service", "email@gmail.com",
                "API Licence Type", "API License URL");
        return apiInfo;
    }

    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }
}

感谢。

1 个答案:

答案 0 :(得分:1)

如果将@PathVariable替换为@ModelAttribute,它似乎应该按预期工作。

要回答你的问题,是的,它确实支持@PathVariable,但只支持原语或字符串。