swagger-api/swagger-codegen

JAX-RS should have Apache CXF Interface gateway

Open

#714 opened on May 4, 2015

View on GitHub
 (7 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
General: SuggestionServer: Javahelp wanted

Description

From https://github.com/swagger-api/swagger-editor/issues/423

Generate Server - JAX-RS should have Apache CXF Interface gateway, while it should not have Implementation class by itself. This gives developers seamless ability to be able to generate Apache CXF based JAX-RS Service (rather than presently produced Jersey API based Implementation). Assume the application is to go through Agile cycle, and is supposed to have a contract change in future, providing interface in server code to be extended in a different place to write complete service implementation would keep the Server Interface API and Implementation independent.

Contributor guide

Tech stack
java
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
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
Understanding of Swagger Codegen generator architectureFamiliarity with JAX RS annotationsKnowledge of Apache CXF configurationExperience with Mustache templates
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
The issue requests a new Apache CXF Interface gateway for JAX RS server generation. Start by examining the existing JAX RS server code generator (e.g., JAXRSServerCodegen.java) and the corresponding Mustache templates in the modules/swagger codegen/src/main/resources/ directory. Understand how the Jersey based implementation is generated, then design a new generator class (e.g., CXFServerCodegen) that extends DefaultCodegen. Create new Mustache templates for CXF interface and implementation classes. The developer should review existing PRs or comments in the issue for any prior attempts or guidance. The goal is to generate interface and implementation files that leverage Apache CXF annotations and configuration.