swagger-api/swagger-codegen

Create language-specified base class

Open

#6059 opened on Jul 14, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Enhancement: Generalhelp wanted

Description

Description

As the awesome Swagger Codegen community adds more generators (e.g clients, servers) to Swagger Codegen, we want to refactor some generators to create language-specific base class so as to reuse the code that are common to generators for the same langauges. Here are a few examples

C++ C# Java Typescript

Here is a list to track progress:

Swagger-codegen version

Latest master

Suggest a Fix/Enhancement

If anyone wants to work on the base class creation, please reply to let us know.

Contributor guide

Tech stack
javarest api
Domain
toolingdeveloper experience
Issue type
refactor
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
Java programmingSwagger Codegen architectureTarget language knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Study existing abstract base classes like AbstractCppCodegen.java, AbstractCSharpCodegen.java, and AbstractJavaCodegen in the module swagger codegen/src/main/java/io/swagger/codegen/languages/. Understand the pattern used to share common code. Then, for a chosen language (e.g., Python), create a new abstract class extending the appropriate class and refactor the existing generator. Reference PR #7197 for an example of how to do this for Go.