lb4 openapi generator produces invalid TypeScript code when OpenAPI parameters contain hyphens
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 76/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- node.js, openapi, typescript
- Área
- backend-api-design
Línea de trabajo
Empieza leyendo el código del generador OpenAPI de lb4 que construye los argumentos de los métodos del controlador y sigue cómo asigna los nombres de los parámetros de la especificación OpenAPI al TypeScript generado. Reproduce el problema con la especificación proporcionada e inspecciona el controlador generado. El trabajo estará terminado cuando los nombres con guiones se normalicen de forma coherente en los argumentos de las llamadas al servicio y el TypeScript generado compile.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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);
}
- Lenguaje dominante
- TypeScript
- Estrellas
- 5.1k
- Forks
- 1.1k
- Merge medio
- 1 d 23 h
- PR fusionados (30 d)
- 44
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de loopbackio/loopback-next
-
Avoid constructor source scanning for classes without a base class in @loopback/contextPosiblemente ocupada @zuhairkhalid229 la tomó hace 14 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
loopbackio/loopback-next#11878 ·
Los mantenedores suelen responder en 1 día
-
Docs good first issue help wanted
Dificultad 1/5 1-3 horas Aptitud para principiantes 68/100
loopbackio/loopback-next#683 · 3 comentarios ·
Los mantenedores suelen responder en 1 día
-
Loopback packages include an older core peer dependency, which causes installation failuresPosiblemente ocupada @abd1rahmane la tomó hace 6 días. Abiertobug
Dificultad 3/5 Medio día Aptitud para principiantes 66/100
loopbackio/loopback-next#11901 ·
Los mantenedores suelen responder en 1 día
-
Model discovery should populate `jsonSchema.maxLength` alongside `length` to support strict-mode validationPosiblemente ocupada @officialasishkumar la tomó hace 8 días. Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
loopbackio/loopback-next#11869 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 55/100
loopbackio/loopback-next#11726 ·
Los mantenedores suelen responder en 1 día
Todos los issues de loopbackio/loopback-next
Issues similares
-
truapi-release
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
paritytech/product-sdk#529 ·
Los mantenedores suelen responder en 1 día
-
Environments table lists page size 5 after 30Posiblemente ocupada @raus7n la tomó hoy. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
litmuschaos/litmus#5743 ·
Los mantenedores suelen responder en 2 días
-
desktop grp:admin-donors type:graphics-bug ui-admin
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
milind-soni/OpenMausBot#6730 ·
Los mantenedores suelen responder en 1 día
-
Status: Triage Type: Bug / Error
Dificultad 2/5 1-3 horas Aptitud para principiantes 69/100
mermaid-js/mermaid-v13#1059 ·
Los mantenedores suelen responder en 1 día