Swagger documentation pour le Printemps Paginable interface

J'ai développé une microservice à l'aide de Printemps de Démarrage. La documentation de l'API REST est faite avec Swagger. Un peu de REPOS des ressources, l'utilisation de Printemps concepts de fournir la pagination pour gratuit. Ci-dessous est un exemple:

@RequestMapping(value = "/buckets", method = GET)
public PagedResources list(Pageable pageable, PagedResourcesAssembler assembler) {
    return bucketService.listBuckets(pageable, assembler);
}

Si j'ouvre le Style de la page, le formulaire ci-dessous est disponible pour la ressource:

Swagger documentation pour le Printemps Paginable interface

Le problème que j'ai est que le paginable paramètre est détecté avec un contenu de type application/json et je ne sais pas comment passer d'une valeur à modifier la taille de la page par exemple. Toutes les valeurs semblent être ignorés.

Est-il possible de passer des paramètres de requête comme objet JSON? ou est-il possible de configurer Swagger pour générer la requête indépendante des champs de paramètre pour les getters contenue par la Paginable interface?

Veuillez noter que je suis en utilisant Springfox avec Gradle:

compile 'io.springfox:springfox-spring-web:2.3.1'
compile 'io.springfox:springfox-swagger2:2.3.1'
compile 'io.springfox:springfox-swagger-ui:2.3.1'
  • Êtes-vous à l'aide de printemps-fox pour générer le Swagger spec dans le RESTE du contrôleur?
  • Oui, je suis en utilisant Springfox dans la version 2.3.1.
InformationsquelleAutor Laurent | 2016-02-15
  1. 29

    C'est un problème connu avec le Printemps-Fox. Voir L'Émission De #755. Basé sur zdila commentaire Deux à cette époque alternative est d'ajouter @ApiImplicitParams qui n'est pas idéal, mais ça fonctionne.

    @ApiImplicitParams({
    @ApiImplicitParam(name = "page", dataType = "integer", paramType = "query",
            value = "Results page you want to retrieve (0..N)"),
    @ApiImplicitParam(name = "size", dataType = "integer", paramType = "query",
            value = "Number of records per page."),
    @ApiImplicitParam(name = "sort", allowMultiple = true, dataType = "string", paramType = "query",
            value = "Sorting criteria in the format: property(,asc|desc). " +
                    "Default sort order is ascending. " +
                    "Multiple sort criteria are supported.")
})

    [Swagger documentation pour le Printemps Paginable interface

    Un https://github.com/springfox/springfox/issues/755

    Deux https://github.com/springfox/springfox/issues/755#issuecomment-135059871

    • J'ai trouvé, j'ai dû utiliser dataType = "int" sinon, le type de données sort pas défini comme indiqué dans l'image.
    • Il semble que le problème a été corrigé et la réponse pourrait par conséquent être mis à jour..
    InformationsquelleAutor Vineet Bhatia
  2. 17

    Bâtiment sur Vineet Bhatia réponse, vous pouvez placer la solution dans un annotations personnalisées pour la réutilisabilité:

    @Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@ApiImplicitParams({
    @ApiImplicitParam(name = "page", dataType = "int", paramType = "query", value = "Results page you want to retrieve (0..N)"),
    @ApiImplicitParam(name = "size", dataType = "int", paramType = "query", value = "Number of records per page."),
    @ApiImplicitParam(name = "sort", allowMultiple = true, dataType = "string", paramType = "query", value = "Sorting criteria in the format: property(,asc|desc). "
            + "Default sort order is ascending. " + "Multiple sort criteria are supported.") })
@interface ApiPageable {
}

    Qui peut ensuite être utilisé comme:

    @ApiPageable
public Page<Data> getData(Pageable pageRequest) {
    • Cela ne peut pas fonctionner comme ça. 'ApiImplicitParams' not applicable to annotation type
    • A très bien fonctionné pour la version 2.8.0
    • Assurez-vous d'utiliser @ApiIgnore annotation à l' Pageable paramètre.
    InformationsquelleAutor Sean Connolly
  3. 9

    Vineet Bhatia, en réponse à @ApiImplicitParams a l'air bien. Mais j'ai fait face à la situation, quand @ApiIgnor et @ApiParam(hidden = true) ne pas travailler et vous pouvez toujours observer les asembler et paginable params. J'ai résolu ce problème par l'ajout de la ligne suivante

    docket.ignoredParameterTypes(Pageable.class, PagedResourcesAssembler.class);

    à la fiche de haricots dans mon SwaggerConfig.

    InformationsquelleAutor Mykola Lavrenko
  4. 3

    Réponse de Vineet Bhatia auront problème de validation lorsque vous sont pas en cours d'exécution sur l'hôte local. Il plaidera en faveur de paramètres entiers qu'ils ne sont pas correspondant à json schema.

    J'ai donc changé entier en chaîne de caractères:

        @ApiImplicitParams({
        @ApiImplicitParam(name = "page", dataType = "string", paramType = "query",
                value = "Results page you want to retrieve (0..N)"),
        @ApiImplicitParam(name = "size", dataType = "string", paramType = "query",
                value = "Number of records per page."),
        @ApiImplicitParam(name = "sort", allowMultiple = true, dataType = "string", paramType = "query",
                value = "Sorting criteria in the format: property(,asc|desc). " +
                        "Default sort order is ascending. " +
                        "Multiple sort criteria are supported.")
})
    • Où est l'erreur de validation s'affiche à l'écran?
    InformationsquelleAutor Evgeny Konurbaev
  5. 2

    Pour les personnes qui veulent résoudre ce problème en 2019. Cette configuration via springfox documentation fonctionne très bien, sauf que vous ne pouvez pas définir la description des paramètres.

    Code est ici.

    https://github.com/springfox/springfox/blob/ef1721afc4c910675d9032bee59aea8e75e06d27/springfox-data-rest/src/main/java/springfox/documentation/spring/data/rest/configuration/SpringDataRestConfiguration.java

    • avec cette classe, j'obtiens l'erreur suivante: Causée par: org.springframework.les haricots.usine.NoSuchBeanDefinitionException: Pas de qualification bean de type " org.springframework.les données.le repos.de base.config.RepositoryRestConfiguration " disponible: attendre au moins 1 fève qui se qualifie comme autowire candidat. La dépendance des annotations: {}
    InformationsquelleAutor helsonxiao
  6. 0

    Répondre à la validation problème indiqué par Evgeny.

    À l'aide de

    @ApiImplicitParams({
    @ApiImplicitParam(name = "page", dataType = "int", paramType = "query", value = "Results page you want to retrieve (0..N)"),
    @ApiImplicitParam(name = "size", dataType = "int", paramType = "query", value = "Number of records per page."),
    @ApiImplicitParam(name = "sort", allowMultiple = true, dataType = "string", paramType = "query", value = "Sorting criteria in the format: property(,asc|desc). "
            + "Default sort order is ascending. " + "Multiple sort criteria are supported.") })

    déclenche une exception:

    Illegal DefaultValue  for parameter type integer
java.lang.NumberFormatException: For input string: ""
    at java.base/java.lang.NumberFormatException.forInputString(NumberFormatException.java:68)
    at java.base/java.lang.Long.parseLong(Long.java:709)
    at java.base/java.lang.Long.valueOf(Long.java:1151)
    at io.swagger.models.parameters.AbstractSerializableParameter.getExample(AbstractSerializableParameter.java:412)
    at jdk.internal.reflect.GeneratedMethodAccessor366.invoke(Unknown Source)
    at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.base/java.lang.reflect.Method.invoke(Method.java:567)
    at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:688)
    at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeFields(BeanSerializerBase.java:719)
    at com.fasterxml.jackson.databind.ser.BeanSerializer.serialize(BeanSerializer.java:155)
    at com.fasterxml.jackson.databind.ser.impl.IndexedListSerializer.serializeContents(IndexedListSerializer.java:119)
    at com.fasterxml.jackson.databind.ser.impl.IndexedListSerializer.serialize(IndexedListSerializer.java:79)

    (au moins, il le fait avec springfox-swagger2 et springfox-swagger2-l'interface utilisateur de la version 2.9.2)

    Vous pouvez éviter de l'exception en suivant Evgeny de réponse ou en ajoutant des valeurs par défaut et des exemples de valeurs pour les paramètres entiers:

    @ApiImplicitParams({
    @ApiImplicitParam(name = "page", dataType = "int", paramType = "query", value = "Results page you want to retrieve (0..N)", defaultValue = "0", example = "2"),
    @ApiImplicitParam(name = "size", dataType = "int", paramType = "query", value = "Number of records per page.", defaultValue = "20", example = "10"),
    @ApiImplicitParam(name = "sort", allowMultiple = true, dataType = "string", paramType = "query", value = "Sorting criteria in the format: property(,asc|desc). "
            + "Default sort order is ascending. " + "Multiple sort criteria are supported.") })
    InformationsquelleAutor Nils Samuelsson
  7. -1

    Bien que la solution avec les paramètres implicites des travaux, il introduit beaucoup d'extra, cassant le code. En fin de compte, nous sommes allés avec la solution suivante:

    @GetMapping(value = "/")
public HttpEntity<PagedResources<Item>> getItems(
    @RequestParam(value = "page", required = false) Integer page,
    @RequestParam(value = "size", required = false) Integer size,
    PagedResourcesAssembler assembler) {
    Page<Item> itemPage = itemService.listItems(PageRequest.of(page, size, Sort.unsorted()));
    return new ResponseEntity<>(assembler.toResource(itemPage), HttpStatus.OK);
}

    Nous passer un PageRequest (qui implémente Pageable) à notre service, qui renvoie un Page. (tous de org.springframework.data.domain).

    La org.springframework.data.web.PagedResourcesAssembler obtient injecté automatiquement via la méthode de contrôleur et permet de cartographier les Éléments de org.springframework.hateoas.PagedResources

    Nous n'avons pas besoin dynamique de tri nous avons donc omis; cela pose quelques problèmes pour ajouter un tri depuis springfox ne pas jouer gentil avec org.springframework.les données.domaine.De tri.

    InformationsquelleAutor Adriaan Koster