OpenAPITools/openapi-generator

[Server] support interface and implementation classes for API controllers

Open

#426 opened on Jul 1, 2018

View on GitHub
 (11 comments) (20 reactions) (0 assignees)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

Description

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
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.
1-2 days
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.
clear
Prerequisites
Mustache templatingJava SpringOpenAPI generator architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
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.