OpenAPITools/openapi-generator

[Server] support interface and implementation classes for API controllers

Open

#426 geöffnet am 1. Juli 2018

Auf GitHub ansehen
 (11 Kommentare) (20 Reaktionen) (0 zugewiesene Personen)Java (26.243 Stars) (7.516 Forks)batch import
HacktoberfestServer: AdaServer: C++Server: C-SharpServer: CeylonServer: EiffelServer: ElixirServer: ErlangServer: GoServer: HaskellServer: JavaServer: KotlinServer: NodejsServer: PHPServer: PerlServer: PythonServer: RubyServer: ScalaServer: Springhelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
javaspring
Domain
backendapi
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Mustache templatingJava SpringOpenAPI generator architecture
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50
Research-Richtung
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.