swagger-api/swagger-codegen

Allow modifying the generated model names by prefix or suffix

Open

#1,255 创建于 2015年9月18日

在 GitHub 查看
 (12 评论) (2 反应) (0 负责人)HTML (12,701 star) (5,474 fork)batch import
Client: C++Client: ClojureClient: DartClient: Flash/ActionScriptClient: GoEnhancement: Featurehelp wanted

描述

This is a feature request for a new (optional) generator parameter.

Summary

It should be possible to specify a prefix and/or suffix which will be added to all model type names when generating the types.

Background The model names generated from the swagger definition have usually quite natural names ... in Java, I got (in my case) for example Supplier, Organization, BusinessUnit. I also have same-named domain classes in the service implementing the API. Now of course I need to write a mapper between those two, and here I can't import both the domain and the API classes. One of them needs to be written out with full package name in the source, and this is ugly:

private Organization mapOrganization(final 
    de.zalando.einkaufshelden.purchase_order.api.rest.model.Organization organization) {

For the similar problem previously with Soap services we used the suffix DTO (for Data Transfer Object) for the objects sent over the wire.

In other projects I've seen a prefix used for all class names to distinguish them from similar ones (think the Swing J* classes).

Proposed solution

There should be two configuration parameters (as a command line parameter in swagger-codegen-cli, as a maven configuration parameter in swagger-codegen-maven-plugin) for specifying a prefix and a suffix to be appended to the model names. Default values would be the empty string. (My name proposals would be modelNamePrefix and modelNameSuffix.)

These could be applied in DefaultCodegen.toModelName before passing the name to the sanitizing transformation.

Alternatively there could be also one single parameter somehow specifying the complete transformation, using a regular expression replacement or similar.

UPDATE API client generators that need to be updated to support model prefix/suffix:

贡献者指南

技术栈
java
领域
apitooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
4
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
3-5 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
JavaSwagger/OpenAPI knowledgeCode generation concepts
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Examine the existing implementation of model name prefix/suffix in language generators that have already been updated (e.g., Java, Python, Ruby) by reviewing PRs #2211, #2161, #2272. Focus on DefaultCodegen.toModelName in the Java codebase. The remaining languages to support are C++, Clojure, Dart, Flash, and Go. Replicate the pattern used in other generators, ensuring prefix and suffix are applied after sanitization. Consult the issue comments for any additional context.