swagger-api/swagger-codegen

[typescript-fetch] response parser doesn't match the generated model

Open

#4,785 opened on Feb 13, 2017

View on GitHub
 (3 comments) (1 reaction) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: TypeScriptIssue: Bughelp wanted

Description

Description

Running swagger-codegen with -l typescript-fetch produces code that can't properly parse the responses.

Swagger-codegen version

2.2.1

Swagger declaration file content or url

https://gist.github.com/farcaller/825c3aaae2a26f6883fb3554b4ccece9

Command line used for generation

swagger-codegen generate -i test.swagger.json -l typescript-fetch -o api/

Steps to reproduce

Generate the file, try to use it.

Based on the swagger config, the server will reply with an object that looks like:

{
"underscore_name": "qwe",
"a_string": "abc",
"a_number": 123
}

Which is processed as:

...
if (response.status >= 200 && response.status < 300) {
    return response.json();
} else {
...

i.e., taking the json as is and returning it as a typed MainTestMessage interface. But the defined model looks like:

export interface MainTestMessage {
    "underscoreName"?: string;
    "aString"?: string;
    "aNumber"?: number;
}

Producing incorrect result.

Related issues

Nothing relevant found.

Suggest a Fix

Unless {"modelPropertyNaming":"original"} is passed in the config, the generator must preform keys re-mapping.

Contributor guide

Tech stack
typescriptrest api
Domain
apideveloper experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptSwagger/OpenAPIswagger codegen basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the typescript fetch template (e.g., api.mustache) to find where the response JSON is returned directly. The fix requires implementing a key remapping function that converts snake case keys to camelCase based on the generated model interfaces, unless the modelPropertyNaming configuration is set to 'original'. Check the existing Java code that handles model property naming to ensure consistency.