swagger-api / swagger-api/swagger-codegen

How to provide Page<Class> as a response by swagger codegen. This will help to get the result on swagger api in page format if records that are getting retrieved is too large.

Open
#4,570 6 comments 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

How to provide Page as a response by swagger codegen. This is required in SpringBoot to support pagination and sorting of spring boot.

Swagger-codegen version

swagger-codegen-maven-plugin - 2.2.1

language - spring

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Spring generator and the swagger-codegen-maven-plugin version 2.2.1 handling of response types. Compare the current generated response behavior with the requested Page pagination and sorting support; done should be a clearly documented or implemented way to produce that response.

Written by the indexing model from the issue text.

Assessment

Tech stack
spring, spring-boot
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.