swagger-api/swagger-codegen

Angular 1 gen - Add basePath to inject and allow empty basepath

Open

#2,788 opened on May 6, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: TypeScriptEnhancement: Generalhelp wanted

Description

Add basePath to the inject array. In order to be able to use angular DI with a different basepath.

If base path is not present in inject array angular DI cannot resolve basePath when uglified.

Check for if(basePath !== undefined) instead of if(basepath) to allow an empty basePath

An empty basepath is handy when the API resides on the same host as the application

static $inject: string[] = ['$http', '$httpParamSerializer','basePath'];

constructor(protected $http: ng.IHttpService, protected $httpParamSerializer?: (d: any) => any, basePath?: string) { if (basePath !== undefined) { this.basePath = basePath; } }

Contributor guide

Tech stack
typescriptjavascript
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.
under 1 hour
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
knowledge of Angular 1 DI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Locate the Angular 1 client template file (likely in modules/swagger codegen/src/main/resources/angular/). Modify the generated service constructor to include 'basePath' in the $inject array and change the condition from 'if (basePath)' to 'if (basePath !== undefined)'. Check existing tests for the generated client to ensure the change works.