Estado actual:

Tengo dos métodos en mi controlador para obtener datos basados ​​en los parámetros que se pasan. El código:

@RestController
@RequestMapping("/samples")
public class SampleController {

    @RequestMapping(value = "/{id}", params = {"cost"}, method = RequestMethod.GET)
    public String getSamplesByIdAndCost(@PathVariable String id, @RequestParam(value = "cost") String cost) {
        return "result";
    }

    @RequestMapping(value = "/{id}", params = {"cost", "size"}, method = RequestMethod.GET)
    public String getSamplesByIdCostAndSize(@PathVariable String id, @RequestParam(value = "cost") String cost,
                                        @RequestParam(value = "size") String size) {
    return "ID : " + id + " / COST : " + cost + " / SIZE : " + size;
    }
}

Todo funciona bien, pero la documentación de swagger no es lo que esperaba.

enter image description here

enter image description here

Pregunta

¿Hay alguna forma de eliminar {? Size, cost} de la URL de solicitud?

Aquí está la información de mi expediente:

@Bean
    public Docket myApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                .pathMapping("/")
                .directModelSubstitute(LocalDate.class,
                        String.class)
                .genericModelSubstitutes(ResponseEntity.class)
                .alternateTypeRules(
                        newRule(typeResolver.resolve(DeferredResult.class,
                                typeResolver.resolve(ResponseEntity.class, WildcardType.class)),
                                typeResolver.resolve(WildcardType.class)))
                .useDefaultResponseMessages(false)
                .globalResponseMessage(RequestMethod.GET,
                        newArrayList(new ResponseMessageBuilder()
                                .code(500)
                                .message("500 message")
                                .responseModel(new ModelRef("Error"))
                                .build()))
                .enableUrlTemplating(true);

    }

    @Autowired
    TypeResolver typeResolver;

    @Bean
    UiConfiguration uiConfig() {
        return new UiConfiguration(
                "validatorUrl",// url
                "none",       // docExpansion          => none | list
                "alpha",      // apiSorter             => alpha
                "schema",     // defaultModelRendering => schema
                UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS,
                false,        // enableJsonEditor      => true | false
                true);        // showRequestHeaders    => true | false
    }
3
Safari137 11 sep. 2016 a las 21:17

5 respuestas

La mejor respuesta

Elimine el atributo 'params' en su anotación @RequestMapping, su código seguirá funcionando.

0
gtonic 11 sep. 2016 a las 18:51

Según este hilo:

La especificación Swagger no permite múltiples puntos finales que difieran según los parámetros de solicitud. Sin embargo, puede usar la función experimental para solucionarlo usando docket#enableUrlTemplates(true). Tenga en cuenta que es experimental. También actualice a 2.7.0

1
barbsan 8 may. 2019 a las 07:47

Varias documentaciones para la misma ruta basadas en cadenas de consulta no es algo que sea compatible con la especificación Swagger y, por lo tanto, no con swagger-ui.

Lo que ha habilitado al configurar enableUrlTemplating(true) parece ser una función de incubación en Springfox, pero no funcionará a partir de ahora con swagger-ui.

La discusión relevante se puede encontrar aquí:

Por ahora, parece que tienes que vivir con rutas que se ven raras en la interfaz de usuario de swagger o tienes que fusionar tu documentación.

3
Tobias Raski 12 sep. 2016 a las 13:10