OpenAPITools/openapi-generator

[Server] support interface and implementation classes for API controllers

Open

#426 建立於 2018年7月1日

在 GitHub 查看
 (11 留言) (20 反應) (0 負責人)Java (26,243 star) (7,516 fork)batch import
HacktoberfestServer: AdaServer: C++Server: C-SharpServer: CeylonServer: EiffelServer: ElixirServer: ErlangServer: GoServer: HaskellServer: JavaServer: KotlinServer: NodejsServer: PHPServer: PerlServer: PythonServer: RubyServer: ScalaServer: Springhelp wanted

描述

Description

For auto-generated server code, we want to generate 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/openapitools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/JavaSpring/api.mustache https://github.com/openapitools/openapi-generator/blob/master/modules/openapi-generator/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.

openapi-generator version

Latest master

Related issues/PRs

https://github.com/swagger-api/swagger-codegen/issues/5431

Suggest a fix/enhancement

If anyone wants to contribute the enhancement, please reply to let us know.

貢獻者指南

技術棧
javaspring
領域
backendapi
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Mustache templatingJava SpringOpenAPI generator architecture
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50
研究方向
Start by examining the existing Java Spring implementation in the mustache files referenced: api.mustache and apiController.mustache. Then, identify other server generators in the repository (e.g., Python Flask, Go Server) and propose similar splits between interface and implementation. Review the linked swagger codegen issue for additional context. The goal is to ensure business logic is not overwritten during code generation.