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.