Howto use custom templates in Swagger

给你一囗甜甜゛ 提交于 2021-01-27 05:11:29

问题


I have this JavaJaxRs dictionary with my templates:

/templates/JavaJaxRs

I edited some of them. And want to use them for my API generation (Code was inspired from this approach from https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen-maven-plugin/src/main/java/io/swagger/codegen/plugin/CodeGenMojo.java):

    System.out.println("Generating API for: " + location);
    DefaultGenerator generator = new DefaultGenerator();
    Swagger swagger = new SwaggerParser().read(location);
    CodegenConfig config = CodegenConfigLoader.forName(this.language);
    config.setOutputDir(new File(this.apiGeneratedSrcPath).getPath());

    if (null != templateDirectory) {
        config.additionalProperties().put(TEMPLATE_DIR_PARAM, templateDirectory);
    }
    if (null != modelPackage) {
        config.additionalProperties().put(MODEL_PACKAGE_PARAM, modelPackage);
    }
    if (null != apiPackage) {
        config.additionalProperties().put(API_PACKAGE_PARAM, apiPackage);
    }
    if (null != invokerPackage) {
        config.additionalProperties().put(INVOKER_PACKAGE_PARAM, invokerPackage);
    }

    if (configOptions != null) {
        for (CliOption langCliOption : config.cliOptions()) {
            if (configOptions.containsKey(langCliOption.getOpt())) {
                config.additionalProperties().put(langCliOption.getOpt(),
                        configOptions.get(langCliOption.getOpt()));
            }
        }
    }

    if (null != configurationFile) {
        Config genConfig = ConfigParser.read(configurationFile);
        if (null != genConfig) {
            for (CliOption langCliOption : config.cliOptions()) {
                if (genConfig.hasOption(langCliOption.getOpt())) {
                    config.additionalProperties().put(langCliOption.getOpt(), genConfig.getOption(langCliOption.getOpt()));
                }
            }
        } else {
            throw new RuntimeException("Unable to read configuration file");
        }
    }

    ClientOptInput input = new ClientOptInput().opts(new ClientOpts()).swagger(swagger);
    input.setConfig(config);

    generator.opts(input).generate();

Somehow i always get the code generated with the standard template file.

UPDATE:

When i remember correctly i had a conditional bug on:

if(null != templateDirectory)
    config.additionalProperties().put(TEMPLATE_DIR_PARAM, templateDirectory);

or somewhere else but with the right condition, code was working as intended.

I let the question stay here, maybe it will help some other users.


回答1:


You can get the help options for the code generator like such:

java -jar swagger-codegen-cli.jar help generate

Which should tell you that you can override the template location with the -t parameter:

java -java swagger-codegen-cli.jar generate -l {language} -t path/to/templates



回答2:


Regarding the above ava -java swagger-codegen-cli.jar generate -l {language} -t path/to/templates,

I've managed to make it work with current being-worked-on-release (2.2.0). With 2.1.6 (current GA) it does not work.

I have posted the following on swagger-codegen at GitHub: https://github.com/swagger-api/swagger-codegen/issues/3188

Did not get any attention though...



来源:https://stackoverflow.com/questions/33436487/howto-use-custom-templates-in-swagger

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!