swagger-api/swagger-codegen

Use Swagger-Annotated Code As Input To swagger-codegen

Open

#5694 opened on May 23, 2017

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

Description

Description

Feature Request: Enable swagger-codegen to generate a client API by inspecting a service's JAR/WAR for Swagger annotations. As a RESTful service developer, I want to be able to generate and publish client JARs for my service as part of that service's build process. This will enable other developers to more easily integrate with my service. To accomplish this, I need to run swagger-codegen before the service is deployed and swagger.json is generated. I think the best approach is to have swagger-codegen inspect either my source files or compiled class files and use them as input.

Suggest a Fix

I have developed a Maven plugin that will scan a JAR file for Swagger annotations, generate swagger.json based on those annotations, then call swagger-codegen to generate a client API from the swagger.json. I was planning to release the plugin as a standalone OSS project, but then I thought it might make sense to contribute it as a new feature to this project.

Contributor guide

Tech stack
javarest api
Domain
apitooling
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.
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.
mostly clear
Prerequisites
JavaMavenSwagger annotationsswagger codegen
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The issue proposes a Maven plugin to scan JARs for Swagger annotations and generate client code via swagger codegen. To implement, first examine the existing swagger codegen architecture and its input formats. Then, review the creator's mention of a standalone plugin approach. Consider contributing to the main project by adding a new Maven mojo that leverages the swagger codegen library. Key files to inspect: the swagger codegen Maven plugin module, the Swagger parser, and the codegen engine. Engage with the maintainers on the issue to clarify desired integration points.