lb4 openapi generator produces invalid TypeScript code when OpenAPI parameters contain hyphens
I maintainer di solito rispondono entro 1 giorno
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 76/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- node.js, openapi, typescript
- Ambito
- backend-api-design
Direzione di ricerca
Inizia leggendo il codice del generatore OpenAPI di lb4 che costruisce gli argomenti dei metodi del controller e segui il modo in cui mappa i nomi dei parametri della specifica OpenAPI nel TypeScript generato. Riproduci il problema con la specifica fornita e controlla il controller generato. Il lavoro è completo quando i nomi con trattini vengono normalizzati in modo coerente negli argomenti delle chiamate al servizio e il TypeScript generato viene compilato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Bug Description
When generating server controllers or services using the lb4 openapi generator from an OpenAPI specification containing query or path parameters with hyphens (kebab-case, like limit-number or status-code), the code generator incorrectly emits literal code containing hyphens (e.g., limit-number, status-code) directly inside the TypeScript method body call arguments instead of sanitizing/camelCasing them into valid TypeScript identifiers (limitNumber, statusCode).
This causes immediate compilation/syntax errors.
Steps to Reproduce
Create an OpenAPI 3.0 specification JSON file (openapi.json) with an endpoint having hyphenated query parameters:
{
"openapi": "3.0.3",
"info": {
"title": "Hyphenated Bug API",
"version": "1.0.0"
},
"paths": {
"/customers": {
"get": {
"operationId": "getCustomers",
"parameters": [
{
"name": "limit-number",
"in": "query",
"schema": { "type": "integer" }
},
{
"name": "status-code",
"in": "query",
"schema": { "type": "string" }
}
],
"responses": {
"200": { "description": "OK" }
}
}
}
}
}
- Run the LoopBack OpenAPI generator command pointing to this spec:
lb4 openapi openapi.json - Inspect the generated Controller file.
Current Output (Buggy Code)
The controller method tries to pass raw hyphenated strings as variable names into the service layer call:
async getCustomers(
@param({
name: 'limit-number',
in: 'query',
// ...
}) limitNumber: number | undefined,
@param({
name: 'status-code',
in: 'query',
// ...
}) statusCode: string | undefined
): Promise<any[]> {
// BUG: TypeScript treats 'limit-number' and 'status-code' as invalid mathematical subtraction expressions
return this.openApiService.getCustomers(limit-number, status-code);
}
Expected Output
The generated controller should correctly use the sanitized camelCase parameter identifiers (limitNumber, statusCode) inside the implementation body:
async getCustomers(...): Promise<any[]> {
return this.openApiService.getCustomers(limitNumber, statusCode);
}
- Lingua principale
- TypeScript
- Stelle
- 5.1k
- Fork
- 1.1k
- Merge medio
- 1g 23h
- PR unite (30g)
- 44
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di loopbackio/loopback-next
-
Avoid constructor source scanning for classes without a base class in @loopback/contextForse già presa @zuhairkhalid229 l’ha presa 14 giorni fa. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
loopbackio/loopback-next#11878 ·
I maintainer di solito rispondono entro 1 giorno
-
Docs good first issue help wanted
Difficoltà 1/5 1-3 ore Idoneità per principianti 68/100
loopbackio/loopback-next#683 · 3 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Loopback packages include an older core peer dependency, which causes installation failuresForse già presa @abd1rahmane l’ha presa 6 giorni fa. Apertabug
Difficoltà 3/5 Mezza giornata Idoneità per principianti 66/100
loopbackio/loopback-next#11901 ·
I maintainer di solito rispondono entro 1 giorno
-
Model discovery should populate `jsonSchema.maxLength` alongside `length` to support strict-mode validationForse già presa @officialasishkumar l’ha presa 8 giorni fa. Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
loopbackio/loopback-next#11869 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 55/100
loopbackio/loopback-next#11726 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di loopbackio/loopback-next
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
milind-soni/OpenMausBot#6730 ·
I maintainer di solito rispondono entro 1 giorno
-
`@angular/[email protected]` depends on vulnerable Vite 7.3.7 - GHSA-p4f5-76q4-ffq7 (Critical RCE)Apertaarea: @angular/build
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
angular/angular-cli#34764 ·
I maintainer di solito rispondono entro 1 giorno
-
status/need-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
google-gemini/gemini-cli#30384 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
P2
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno
-
area:image documentation good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno