In Typescript Client generator, for API endpoint methods, use a class argument instead of individual arguments #5184

PehaSimCorp · 2025-06-05T08:59:46Z

PehaSimCorp
Jun 5, 2025

Hi,
In Typescript Client generator, for API endpoint methods, could we use a class argument instead of individual arguments?

This would assist in;

Generated methods more resistant to signature changes (Adding/removing parameters or changing the order)
Handle having a large number of optional parameters in the endpoint cleanly
Have better support for mocking inputs/outputs in Cypress (and similar methods) by declaring the class.

If the work is simple, I am happy to try this out myself but I'm not sure where to start.

For example
A method generated in the Open API Client:

  get(
    activeAt: Date | null | undefined,
    startAt_From: Date | null | undefined,
    startAt_After: Date | null | undefined,
    startAt_To: Date | null | undefined,
    endAt_From: Date | null | undefined,
    endAt_After: Date | null | undefined,
    endAt_To: Date | null | undefined,
    sortOrder: SortOrder | undefined,
    sortBy: GateOverrideFieldToSortBy | undefined,
    page: number | undefined,
    pageSize: number | undefined,
  ): Observable<SimpleData> {
    let url_ = this.baseUrl + '/v1/SimpleData?';
    if (activeAt !== undefined && activeAt !== null)
      url_ += 'ActiveAt=' + encodeURIComponent(activeAt ? '' + activeAt.toISOString() : '') + '&';
    if (startAt_From !== undefined && startAt_From !== null)
      url_ += 'StartAt.From=' + encodeURIComponent(startAt_From ? '' + startAt_From.toISOString() : '') + '&';
    if (startAt_After !== undefined && startAt_After !== null)
      url_ += 'StartAt.After=' + encodeURIComponent(startAt_After ? '' + startAt_After.toISOString() : '') + '&';
    if (startAt_To !== undefined && startAt_To !== null)
      url_ += 'StartAt.To=' + encodeURIComponent(startAt_To ? '' + startAt_To.toISOString() : '') + '&';
    if (endAt_From !== undefined && endAt_From !== null)
      url_ += 'EndAt.From=' + encodeURIComponent(endAt_From ? '' + endAt_From.toISOString() : '') + '&';
    if (endAt_After !== undefined && endAt_After !== null)
      url_ += 'EndAt.After=' + encodeURIComponent(endAt_After ? '' + endAt_After.toISOString() : '') + '&';
    if (endAt_To !== undefined && endAt_To !== null)
      url_ += 'EndAt.To=' + encodeURIComponent(endAt_To ? '' + endAt_To.toISOString() : '') + '&';
    if (sortOrder === null) throw new Error("The parameter 'sortOrder' cannot be null.");
    else if (sortOrder !== undefined) url_ += 'SortOrder=' + encodeURIComponent('' + sortOrder) + '&';
    if (sortBy === null) throw new Error("The parameter 'sortBy' cannot be null.");
    else if (sortBy !== undefined) url_ += 'SortBy=' + encodeURIComponent('' + sortBy) + '&';
    if (page === null) throw new Error("The parameter 'page' cannot be null.");
    else if (page !== undefined) url_ += 'Page=' + encodeURIComponent('' + page) + '&';
    if (pageSize === null) throw new Error("The parameter 'pageSize' cannot be null.");
    else if (pageSize !== undefined) url_ += 'PageSize=' + encodeURIComponent('' + pageSize) + '&';
    url_ = url_.replace(/[?&]$/, '');

    let options_: any = {
      observe: 'response',
      responseType: 'blob',
      headers: new HttpHeaders({
        Accept: 'application/json',
      }),
    };

    return this.http
      .request('get', url_, options_)
      .pipe(
        _observableMergeMap((response_: any) => {
          return this.processGet(response_);
        }),
      )
      .pipe(
        _observableCatch((response_: any) => {
          if (response_ instanceof HttpResponseBase) {
            try {
              return this.processGet(response_ as any);
            } catch (e) {
              return _observableThrow(e) as any as Observable<SimpleData>;
            }
          } else return _observableThrow(response_) as any as Observable<SimpleData>;
        }),
      );
  }

After change it would look like:

  get(arguments: getSimpleDataArguments): Observable<SimpleData> {
    let url_ = this.baseUrl + '/v1/SimpleData?';
    if (arguments.activeAt !== undefined && arguments.activeAt !== null)
      url_ += 'ActiveAt=' + encodeURIComponent(arguments.activeAt ? '' + arguments.activeAt.toISOString() : '') + '&';
    if (arguments.startAt_From !== undefined && arguments.startAt_From !== null)
      url_ += 'StartAt.From=' + encodeURIComponent(arguments.startAt_From ? '' + arguments.startAt_From.toISOString() : '') + '&';
    if (arguments.startAt_After !== undefined && arguments.startAt_After !== null)
      url_ += 'StartAt.After=' + encodeURIComponent(arguments.startAt_After ? '' + arguments.startAt_After.toISOString() : '') + '&';
    if (arguments.startAt_To !== undefined && arguments.startAt_To !== null)
      url_ += 'StartAt.To=' + encodeURIComponent(arguments.startAt_To ? '' + arguments.startAt_To.toISOString() : '') + '&';
    if (arguments.endAt_From !== undefined && arguments.endAt_From !== null)
      url_ += 'EndAt.From=' + encodeURIComponent(arguments.endAt_From ? '' + arguments.endAt_From.toISOString() : '') + '&';
    if (arguments.endAt_After !== undefined && arguments.endAt_After !== null)
      url_ += 'EndAt.After=' + encodeURIComponent(arguments.endAt_After ? '' + arguments.endAt_After.toISOString() : '') + '&';
    if (arguments.endAt_To !== undefined && arguments.endAt_To !== null)
      url_ += 'EndAt.To=' + encodeURIComponent(arguments.endAt_To ? '' + arguments.endAt_To.toISOString() : '') + '&';
    if (arguments.sortOrder === null) throw new Error("The parameter 'sortOrder' cannot be null.");
    else if (arguments.sortOrder !== undefined) url_ += 'SortOrder=' + encodeURIComponent('' + arguments.sortOrder) + '&';
    if (arguments.sortBy === null) throw new Error("The parameter 'sortBy' cannot be null.");
    else if (arguments.sortBy !== undefined) url_ += 'SortBy=' + encodeURIComponent('' + arguments.sortBy) + '&';
    if (arguments.page === null) throw new Error("The parameter 'page' cannot be null.");
    else if (arguments.page !== undefined) url_ += 'Page=' + encodeURIComponent('' + arguments.page) + '&';
    if (arguments.pageSize === null) throw new Error("The parameter 'pageSize' cannot be null.");
    else if (arguments.pageSize !== undefined) url_ += 'PageSize=' + encodeURIComponent('' + arguments.pageSize) + '&';
    url_ = url_.replace(/[?&]$/, '');

    let options_: any = {
      observe: 'response',
      responseType: 'blob',
      headers: new HttpHeaders({
        Accept: 'application/json',
      }),
    };

    return this.http
      .request('get', url_, options_)
      .pipe(
        _observableMergeMap((response_: any) => {
          return this.processGet(response_);
        }),
      )
      .pipe(
        _observableCatch((response_: any) => {
          if (response_ instanceof HttpResponseBase) {
            try {
              return this.processGet(response_ as any);
            } catch (e) {
              return _observableThrow(e) as any as Observable<SimpleData>;
            }
          } else return _observableThrow(response_) as any as Observable<SimpleData>;
        }),
      );
  }

export interface getSimpleDataArguments
{
    activeAt: Date | null | undefined,
    startAt_From: Date | null | undefined,
    startAt_After: Date | null | undefined,
    startAt_To: Date | null | undefined,
    endAt_From: Date | null | undefined,
    endAt_After: Date | null | undefined,
    endAt_To: Date | null | undefined,
    sortOrder: SortOrder | undefined,
    sortBy: GateOverrideFieldToSortBy | undefined,
    page: number | undefined,
    pageSize: number | undefined,
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

In Typescript Client generator, for API endpoint methods, use a class argument instead of individual arguments #5184

Uh oh!

{{title}}

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

Uh oh!

In Typescript Client generator, for API endpoint methods, use a class argument instead of individual arguments #5184

Uh oh!

PehaSimCorp Jun 5, 2025

Replies: 0 comments

PehaSimCorp
Jun 5, 2025