swagger-api/swagger-codegen

[JaxRS*] javax.ws.rs.core.Response vs. returnTypes

Open

#4,713 opened on Feb 4, 2017

View on GitHub
 (3 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Enhancement: GeneralServer: Javahelp wanted

Description

Description

Currently only the language jaxrs-cxf returns the "real" returnType in the method signatures as opposed to the generic javax.ws.rs.core.Response. All other Jaxrs-languages use javax.ws.rs.core.Response.

IMHO all JaxRS-languages should allow a CLI-flag ("useGenericJaxRsResponse", default value=true for backwards compatibility) whether to use the generic javax.ws.rs.core.Response or the real returnTypes in the method signatures.

Languages to be updated:

  • jaxrs-cxf-cdi
  • jaxrs-spec
  • jaxrs (Jersey)
  • jaxrs-cxf CXF already has the check, but no CLI flag to use the Jaxrs-Response

I added the check for the CLI-flag useGenericResponse

  • jaxrs-cxf-client

I added the check for the CLI-flag useGenericResponse

  • jaxrs-resteasy
  • java
  • spring
Swagger-codegen version

2.2.2

Contributor guide

Tech stack
java
Domain
backendapitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaJAX RSswagger codegen basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the current implementation in jaxrs cxf that already uses real return types and the useGenericResponse flag. Investigate the corresponding templates and code for jaxrs cxf cdi, jaxrs spec, jaxrs (Jersey), jaxrs resteasy, java, and spring languages to understand how they handle the return type. Add a CLI flag 'useGenericJaxRsResponse' with default true for backwards compatibility. Update the mustache templates to conditionally use either javax.ws.rs.core.Response or the actual return type based on the flag. Test the changes across all affected languages.