OpenAPITools / OpenAPITools/openapi-generator

[BUG] Vendor extension is empty/ non-existent

Open
#14,166 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

I'm using OAS3 generator for Java as a Maven plugin to generate POJOs, controllers, delegates etc for my APIs with the Mustache templates from the openapi-generator repository: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/JavaSpring/apiController.mustache

I'm trying to edit this template so that the "@Controller" annotation is generated only if a condition is met. I've searched for multiple solutions for this and one of them was using "vendorExtensions".

I've made the following contract with x-generateController vendorExtension:


openapi: 3.0.0
info:
  title: User API
  description: API for user changes
  contact:
    name: xxx
    url: xxx
    email: xxx
  license:
    name: xxx
    url: xxx
  version: 1.0.0
tags:
  - name: user
x-generateController: True
paths:
  /users:
  ...

And then in the Mustache template file I have put the following:

{{#vendorExtensions.x-generateController}}
@Controller("{{classname}}")
{{/vendorExtensions.x-generateController}}

The generator works just fine without this condition but it seems like it doesn't take into account x-generateController. In fact, if I try to just place it as a comment like this:

// {{vendorExtensions.x-generateController}}
I get only "// " and an empty space. I've also tried putting it at the "endpoint level" and not in the "info level" and the problem is the same.

Is there anything more that I should've done in the configuration? Is there any alternative for a condition in the Mustache template?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with modules/openapi-generator/src/main/resources/JavaSpring/apiController.mustache and reproduce the generation using the contract's x-generateController extension at the shown levels. Compare the generated output with the Mustache expressions for vendorExtensions. Done means the documented extension is available in the relevant template context and conditionally controls the @Controller annotation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.