swagger-api/swagger-codegen

Support interface and implementation classes for API controllers

Open

#5,431 创建于 2017年4月19日

在 GitHub 查看
 (7 评论) (3 反应) (0 负责人)HTML (12,701 star) (5,474 fork)batch import
Enhancement: FeatureFeature List: API serversServer: C-SharpServer: CeylonServer: ErlangServer: GoServer: HaskellServer: JavaServer: NodejsServer: PHPServer: PerlServer: PythonServer: RubyServer: ScalaServer: Springhelp wanted

描述

Description

For auto-generated server code, we want to generated 2 files for each API controller file:

  1. an interface, which will be overwritten by code generation
  2. an implementation class, which will not be overwritten by code generation

Java Spring has already implemented this: https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/JavaSpring/api.mustache https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/JavaSpring/apiController.mustache

The goal is to avoid application/business logic being overwritten by code generation so that there's less overhead when adding/deleting/updating endpoint definition.

Other server generators should leverage similar design.

Swagger-codegen version

Latest master

Suggest a Fix

If anyone has suggestions for better design or want to work on this enhancement for a particular server generator, please reply to let us know. Thank you.

贡献者指南

技术栈
javaspringrest api
领域
backendapi
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
4
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
3-5 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
JavaSpringMustache templatesSwagger codegen internals
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
25
研究方向
Examine the existing Java Spring implementation by reviewing the referenced mustache templates (api.mustache and apiController.mustache) at the given GitHub URLs. Analyze any comments in the issue for design suggestions or prior attempts. Then propose a similar interface/implementation pattern for other server generators, ensuring the generated interface is overwritten and the implementation class is preserved.