[typescript-angular] Add includeEndpointUrl option to include endpoint URLs in generated service comments (#22152)

Adds a new boolean option 'includeEndpointUrl' that, when enabled, includes endpoint URL information as JSDoc comments in generated service methods and interfaces. This helps developers quickly identify the HTTP method and path for each API operation.

Co-authored-by: Robin Csutoras <[email protected]>

Author: csutorasr

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAngularClientCodegen.java

@@ -83,6 +83,7 @@ public static enum PROVIDED_IN_LEVEL {none, root, any, platform}
     public static final String RXJS_VERSION = "rxjsVersion";
     public static final String NGPACKAGR_VERSION = "ngPackagrVersion";
     public static final String ZONEJS_VERSION = "zonejsVersion";
+    public static final String INCLUDE_ENDPOINT_URL = "includeEndpointUrl";
 
     protected String ngVersion = "20.0.0";
     @Getter @Setter
@@ -155,6 +156,7 @@ public TypeScriptAngularClientCodegen() {
         this.cliOptions.add(new CliOption(RXJS_VERSION, "The version of RxJS compatible with Angular (see ngVersion option)."));
         this.cliOptions.add(new CliOption(NGPACKAGR_VERSION, "The version of ng-packagr compatible with Angular (see ngVersion option)."));
         this.cliOptions.add(new CliOption(ZONEJS_VERSION, "The version of zone.js compatible with Angular (see ngVersion option)."));
+        this.cliOptions.add(CliOption.newBoolean(INCLUDE_ENDPOINT_URL, "Include endpoint URL as comment in generated service methods.", false));
     }
 
     @Override
@@ -309,6 +311,11 @@ public void processOpts() {
         additionalProperties.put("isQueryParamObjectFormatJson", getQueryParamObjectFormatJson());
         additionalProperties.put("isQueryParamObjectFormatKey", getQueryParamObjectFormatKey());
 
+        if (additionalProperties.containsKey(INCLUDE_ENDPOINT_URL)) {
+            boolean includeEndpointUrl = Boolean.parseBoolean(additionalProperties.get(INCLUDE_ENDPOINT_URL).toString());
+            additionalProperties.put(INCLUDE_ENDPOINT_URL, includeEndpointUrl);
+        }
+
     }
 
     @Data

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache

@@ -74,6 +74,9 @@ export class {{classname}} extends BaseService {
 {{#notes}}
      * {{.}}
 {{/notes}}
+{{#includeEndpointUrl}}
+     * @endpoint {{httpMethod}} {{{path}}}
+{{/includeEndpointUrl}}
      {{^useSingleRequestParameter}}
      {{#allParams}}
      * @param {{paramName}} {{description}}

modules/openapi-generator/src/main/resources/typescript-angular/apiInterface.mustache

@@ -38,6 +38,9 @@ export interface {{classname}}Interface {
     /**
      * {{summary}}
      * {{notes}}
+{{#includeEndpointUrl}}
+     * @endpoint {{httpMethod}} {{{path}}}
+{{/includeEndpointUrl}}
      {{^useSingleRequestParameter}}
      {{#allParams}}* @param {{paramName}} {{description}}
      {{/allParams}}{{/useSingleRequestParameter}}{{#useSingleRequestParameter}}{{#allParams.0}}* @param requestParameters