acacode / acacode/swagger-typescript-api

Generated HTTP client adds extra ampersands to the request URL for each empty array passed in query

Offen
#621 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
4.1k
Forks
436
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

The generated HTTP client adds extra ampersands to the request URL for each empty array passed in query.

I noticed this with my API that does a database query with a lot of possible filters where many of them are arrays. If I pass most of my filter options as empty arrays the request URL will contain parts like `...&&&&&&&&SomeFilter=...`.

This seems to be because of the logic in the [toQueryString](https://github.com/prog13/swagger-typescript-api/blob/167523600c57cfc3c6be7e933c5c4ec08e5d6c97/templates/base/http-clients/fetch-http-client.eta#L87) method. The `query` may contain empty arrays that are not filtered out so they will be set in `keys` which then maps an empty array to an empty string (via `addArrayQueryParam`) and then joins the result with `&` which causes the issue.

To solve this you could either filter out the empty arrays already when setting `keys` (same place where it's now filtering out undefined values) or you could process the joined string to filter out extra consecutive ampersands and a trailing ampersand with for example this `.replaceAll(/&&+/g, '&').replace(/&$/, '')`. I think it's cleaner to filter out the empty arrays earlier though.

I might have some time to submit a PR for this.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.