swagger-api/swagger-codegen

[Angular2] attributes are snake_cased

Open

#4,774 opened on Feb 11, 2017

View on GitHub
 (11 comments) (9 reactions) (0 assignees)HTML (5,474 forks)batch import
Client: TypeScriptIssue: Bughelp wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Description

In my generated files, the attribute in the model interfaces are all camelCased, but the fetched data is snake_cased and not changed.

export interface User {
    /**
     * The ID of the user.
     */
    userId: number;
[...]

returned object: { user_id: 12, ... }

Swagger-codegen version

the version used by http://editor.swagger.io/

Notes

However, when sending some formParams (POST) to the server, then the generated code converts the attributes:

if (challengeId !== undefined) {
    formParams.set('challenge_id', <any>challengeId);
}

Contributor guide

Research direction
Investigate the code generation template for Angular models in swagger codegen. Identify where the property name transformation occurs (likely in the Mustache template or the Java code generator). Check if there is a configuration option to toggle between snake case and camelCase.
Tech stack
angulartypescript
Domain
backendapi
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
AngularTypeScriptSwagger/OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70