Add Spring pagination with vendor extension x-spring-paginated by diyfr · Pull Request #3357 · swagger-api/swagger-codegen

diyfr · 2016-07-13T08:09:40Z

Fix [https://github.com//issues/3353](https://github.com/swagger-api/swagger-codegen/issues/3353]

x-spring-paginated

Add Spring pagination to API. Transform array of object to Spring Page [http://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/domain/Page.html], with pagination options : size, page, sort

x-spring-paginated: boolean

Generate ApiImplicitParams and Pageable object to method.

in petstore.json

  "/pet/findByStatus": {
      "get": {
        "tags": [
          "pet"
        ],
        "summary": "Finds Pets by status",
        "description": "Multiple status values can be provided with comma seperated strings",
        "operationId": "findPetsByStatus",
        "x-spring-paginated": true, /* HERE */
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [ .............

generate in PetApi.java

@ApiOperation(value = "Finds Pets by status", notes = "Multiple status values can be provided with comma seperated strings", response = Pet.class, responseContainer = "List", authorizations = {
        @Authorization(value = "petstore_auth", scopes = {
            @AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
            @AuthorizationScope(scope = "read:pets", description = "read your pets")
            })
    }, tags={ "pet",  })
    @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.")
    }) 
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "successful operation", response = Pet.class),
        @ApiResponse(code = 400, message = "Invalid status value", response = Pet.class) })
    @RequestMapping(value = "/pet/findByStatus",
        produces = { "application/json", "application/xml" }, 
        method = RequestMethod.GET)
    ResponseEntity<List<Pet>> findPetsByStatus(@ApiParam(value = "Status values that need to be considered for filter", defaultValue = "available") @RequestParam(value = "status", required = false, defaultValue="available") List<String> status, @ApiIgnore final Pageable pageable);

@cbornet I modified SpringCodeGen.java >>
application.properties generate swagger.properties for springmvc profil replaced by application.mustache.
and removed application.properties

…odegen into SpringPagination

cbornet · 2016-07-13T08:24:39Z

modules/swagger-codegen/src/main/resources/JavaSpring/libraries/spring-boot/pom.mustache

        </dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-data-jpa</artifactId>


Include spring-data-commons instead

@cbornet I think it is easier to change application.properties than change pom.xml.
If you need persistence (what project do not need) it will change pom for recommender dependency and application.properties for add datasource.

A lot of projects don't use JPA !! Think about NoSQL, Mongo, Cassandra, ...

It's less intrusive to let the user add spring-boot-starter-data-jpa if he needs JPA and it will not cause any problem to have spring-data-commons in parallel.

ok @cbornet
Next action :

Change dependency to spring-data-common
SpringFox plugin parameter
But I have to leave , I could not go back to the code before mid-August

Will you at least have access to your gh account ?
In that case I can PR to your fork and you will just have to merge.

@cbornet via mobile only . no position with git client
Otherwise we demand the integration and adapts after you ?

TODO (for me :) ) update Wiki page for vendor extension...

@cbornet if you want you can to directly modify the branch of my git repository (access contributor)

diyfr · 2016-07-13T08:34:10Z

@wing328 The build failed with ruby implementation ?

wing328 · 2016-07-13T09:50:25Z

@diyfr I've restarted the job and all tests have passed.

diyfr · 2016-07-13T11:18:12Z

@wing328 I see with @cbornet for some changes

cbornet · 2016-07-13T11:55:41Z

samples/server/petstore/springboot/src/main/java/io/swagger/api/ApiException.java

@@ -1,5 +1,6 @@
 package io.swagger.api;

+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.SpringCodegen", date = "2016-07-13T09:45:49.128+02:00")


generate the samples with hideGenerationTimestamps=true

Where specifying this ?

…che to library profiles

wing328 · 2016-07-13T14:17:10Z

Some of the commits (as shown in the Commits tab) are not linked to your Github account, which means this PR won't count as your contribution in https://github.com/swagger-api/swagger-codegen/graphs/contributors.

Let me know if you need help fixing it.

Ref: http://stackoverflow.com/questions/3042437/change-commit-author-at-one-specific-commit

cbornet · 2016-07-13T16:34:06Z

modules/swagger-codegen/src/main/resources/JavaSpring/libraries/spring-mvc/swagger.mustache

@@ -1,3 +1,4 @@
+#Spring MVC swagger.properties
 springfox.documentation.swagger.v2.path=/api-docs
 server.contextPath={{^contextPath}}/{{/contextPath}}{{#contextPath}}{{contextPath}}{{/contextPath}}


server.contextPath is not used by spring-mvc. Must be removed

diyfr · 2016-07-13T21:53:38Z

oups @wing328 my git took the overall configuration instead of the project

…che to library profiles

…odegen into SpringPagination

wing328 · 2016-07-19T08:01:09Z

@diyfr Another way to fix the commit authorship is to add that email address as secondary email in your Github account.

diyfr · 2016-08-08T09:48:11Z

@wing328 I just got back from holidays. commit authorship is fixed.
I plan to further modify the solution by adding a plugin springfox as proposed @cbornet
But it will not be immediate.

wing328 · 2016-08-08T10:36:46Z

@diyfr I hope you'd a great vacation.

Please take your time.

My understanding is that this PR is not a breaking change. Please let me know if that's not the case.

diyfr · 2016-08-19T14:02:37Z

@cbornet
Before making a delivery
This classes are never used or we have not implemented :

ApiOriginFilter ->we have org.springframework.web.bind.annotation.CrossOrigin ?
ApiException, NotFoundException :
-> Generated code is wrong. example in PetStore(simple) different schema for responses

  /pets:  
......    
    responses:
        '200':  
          description: pet response  
          schema:  
            $ref: '#/definitions/pet'  
        default:  
          description: unexpected error  
          schema:  
            $ref: '#/definitions/errorModel'

-> Generated annotation :

@ApiResponse(code = 200, message = "pet response", response = Pet.class),
@ApiResponse(code = 200, message = "unexpected error", response = Pet.class) })

There are several ways to treat it . Which you advise ?

diyfr · 2016-08-22T06:30:59Z

For ApiException change extends Exception to RuntimeException.
Now you can use ApiException without declaring thows in signature method.
For example :

throw new ApiException(000,"Can't send action code , number invalid or external service is unavailable");

And for get the code in the JsonResponse need to add a custom ErrorAttribute

   @Bean
    public ErrorAttributes errorAttributes() {
        return new DefaultErrorAttributes() {

            @Override
            public Map<String, Object> getErrorAttributes(
                    RequestAttributes requestAttributes,
                    boolean includeStackTrace) {
                Map<String, Object> errorAttributes = super.getErrorAttributes(requestAttributes, includeStackTrace);
                Throwable error = getError(requestAttributes);
                if (error instanceof ApiException) {
                    errorAttributes.put("errorCode", ((ApiException)error).getErrorCode());
                }
                return errorAttributes;
            }

        };
    }

cbornet · 2016-08-22T09:23:38Z

@diyfr I think the error management should be done in a distinct PR. This one is already too big with a messy commit history (maybe you could squash the commits).
Otherwise it is a good idea.
I believe the ApiException class was inherited from the JAX-RS generator so it can be adapted for Spring. But I don't know if the swagger-codegen core handles error models : there is nothing in swagger spec telling that 'default' response is an error.
As for the CORS filter, the cleaner way would probably be to override addCorsMappings() in a WebMvcConfigurerAdapter bean as decribed here. Just ensure that it also works with good old Spring (without boot).

cbornet · 2016-08-22T09:32:16Z

modules/swagger-codegen/src/main/resources/JavaSpring/api.mustache

        consumes = { {{#consumes}}"{{{mediaType}}}"{{#hasMore}}, {{/hasMore}}{{/consumes}} },{{/hasConsumes}}{{/singleContentTypes}}
        method = RequestMethod.{{httpMethod}})
-    {{#java8}}default {{/java8}}{{#async}}{{^java8}}Callable{{/java8}}{{#java8}}CompletableFuture<{{/java8}}{{/async}}ResponseEntity<{{>returnTypes}}>{{#async}}>{{/async}} {{operationId}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{#hasMore}},{{/hasMore}}{{/allParams}}){{^java8}};{{/java8}}{{#java8}} {
+    {{#java8}}default {{/java8}}{{#async}}{{^java8}}Callable{{/java8}}{{#java8}}CompletableFuture<{{/java8}}{{/async}}ResponseEntity<{{>returnTypes}}>{{#async}}>{{/async}} {{operationId}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{#hasMore}},{{/hasMore}}{{/allParams}}{{#vendorExtensions.x-spring-paginated}}, @ApiIgnore final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{^java8}};{{/java8}}{{#java8}} {


Don't use ApiIgnore but configure .ignoredParameterTypes(Pageable.class) in the docket (only if not using the plugin)

wing328 · 2016-08-22T09:33:18Z

Agreed with @cbornet to put other features in a separate PR.

(I'll squash the commits when merging this PR)

diyfr · 2016-08-22T09:41:24Z

I thought to close this pull request.
I want making one that corrects the differents hotfix mentioned on this PR.
And then make a new one for the extension x-paginated, because there are too many commit with the authors problems. I'd suggest something cleaner

diyfr and others added 7 commits July 13, 2016 07:45

Add x-spring-pageable

e908589

Add dependency and autoconfigure boot exclusions

c788a32

Use application.properties.mustache

a6e3194

Use application.mustache instead of application.properties

a8a0953

Update Petstore SpringBoot sample

1b483da

Merge branch 'SpringPagination' of https://github.com/diyfr/swagger-c…

3d070b8

…odegen into SpringPagination

add vendor extension x-spring-pageable to sample petstore.json

35dd54f

diyfr mentioned this pull request Jul 13, 2016

[Spring] generate paginated resources #3353

Open

cbornet reviewed Jul 13, 2016
View reviewed changes

wing328 added Enhancement: Feature Server: Spring labels Jul 13, 2016

wing328 added this to the v2.3.0 milestone Jul 13, 2016

cbornet reviewed Jul 13, 2016
View reviewed changes

diyfr added 2 commits July 13, 2016 14:52

Update vendor extension to x-spring-paginated, move application musta…

3fe3558

…che to library profiles

remove springboot excludes

f89111c

diyfr changed the title ~~Add Spring pagination with vendor extension x-spring-pageable~~ Add Spring pagination with vendor extension x-spring-paginated Jul 13, 2016

remove spring-mvc application.mustache to swagger.mustache

5629d46

cbornet reviewed Jul 13, 2016
View reviewed changes

Add dependency and autoconfigure boot exclusions

d8b7bb6

diyfr added 8 commits July 14, 2016 11:33

Update Petstore SpringBoot sample

82ae76e

Use application.properties.mustache

e464165

Use application.mustache instead of application.properties

78cb757

add vendor extension x-spring-pageable to sample petstore.json

2167b8d

Update vendor extension to x-spring-paginated, move application musta…

4a61609

…che to library profiles

remove springboot excludes

ea8b6ef

remove spring-mvc application.mustache to swagger.mustache

4d01ad4

Merge branch 'SpringPagination' of https://github.com/diyfr/swagger-c…

a36d68f

…odegen into SpringPagination

wing328 modified the milestones: v2.2.1, v2.3.0 Aug 8, 2016

wing328 modified the milestones: v2.2.2, v2.3.0 Aug 8, 2016

Upgrade SpringBoot version 1.3.5 to 1.4.0

96d37f5

wing328 closed this Aug 22, 2016

wing328 reopened this Aug 22, 2016

cbornet reviewed Aug 22, 2016
View reviewed changes

diyfr closed this Aug 26, 2016

zzsoszz mentioned this pull request Apr 28, 2017

why x-spring-paginated vender extentions doesn't work for me? #5506

Open

david1601 mentioned this pull request Jan 17, 2020

[Java][Spring] Add Spring pagination with vendor extension x-spring-paginated OpenAPITools/openapi-generator#5022

Merged

5 tasks

		@@ -1,5 +1,6 @@
		package io.swagger.api;

		@javax.annotation.Generated(value = "class io.swagger.codegen.languages.SpringCodegen", date = "2016-07-13T09:45:49.128+02:00")

Conversation

diyfr commented Jul 13, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

x-spring-paginated

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

diyfr Jul 13, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

diyfr commented Jul 13, 2016

Uh oh!

wing328 commented Jul 13, 2016

Uh oh!

diyfr commented Jul 13, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wing328 commented Jul 13, 2016

Uh oh!

cbornet Jul 13, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

diyfr commented Jul 13, 2016

Uh oh!

wing328 commented Jul 19, 2016

Uh oh!

diyfr commented Aug 8, 2016

Uh oh!

wing328 commented Aug 8, 2016

Uh oh!

diyfr commented Aug 19, 2016

Uh oh!

diyfr commented Aug 22, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cbornet commented Aug 22, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wing328 commented Aug 22, 2016

Uh oh!

diyfr commented Aug 22, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

diyfr commented Jul 13, 2016 •

edited

Loading

diyfr Jul 13, 2016 •

edited

Loading

cbornet Jul 13, 2016 •

edited

Loading

diyfr commented Aug 22, 2016 •

edited

Loading

diyfr commented Aug 22, 2016 •

edited

Loading