valitydev/openapi-generator
14
0
Fork 0
mirror of https://github.com/valitydev/openapi-generator.git synced 2024-11-08 03:18:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Use static model factory methods

Browse Source 
The `constructFromObject` factory methods should be class methods
(or "static" methods), not instance methods.

With this commit, ApiClient no longer calls the model constructors
directly. Instead, it calls the new static factory method to get the
new instance. If there is no data on the top level, null is returned.

It is still possible for users to call the model constructors
directly, of course.
This commit is contained in:
delenius 2016-02-10 13:35:24 -08:00
parent 847a8e1f3d
commit fa2333717a
15 changed files with 118 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavascriptClientCodegen.java
View File

@ -339,10 +339,10 @@ public class JavascriptClientCodegen extends DefaultCodegen implements CodegenCo
@Override @Override
public String toDefaultValueWithParam(String name, Property p) { public String toDefaultValueWithParam(String name, Property p) {
if (p instanceof RefProperty) {
return ".constructFromObject(data['" + name + "']);";
} else {
String type = normalizeType(getTypeDeclaration(p)); String type = normalizeType(getTypeDeclaration(p));
if (p instanceof RefProperty) {
return " = " + type + ".constructFromObject(data['" + name + "']);";
} else {
return " = ApiClient.convertToType(data['" + name + "'], " + type + ");"; return " = ApiClient.convertToType(data['" + name + "'], " + type + ");";
} }
} }

3
modules/swagger-codegen/src/main/resources/Javascript/ApiClient.mustache
View File

@ -262,8 +262,7 @@
default: default:
if (typeof type === 'function') { if (typeof type === 'function') {
// for model type like: User // for model type like: User
var model = new type(); var model = type.constructFromObject(data);
model.constructFromObject(data);
return model; return model;
} else if (Array.isArray(type)) { } else if (Array.isArray(type)) {
// for array type like: ['String'] // for array type like: ['String']

9
modules/swagger-codegen/src/main/resources/Javascript/model.mustache
View File

@ -35,16 +35,17 @@
{{/vars}} {{/vars}}
}; };
{{classname}}.prototype.constructFromObject = function(data) { {{classname}}.constructFromObject = function(data) {
if (!data) { if (!data) {
return this; return null;
} }
var _this = new {{classname}}();
{{#vars}} {{#vars}}
if (data['{{baseName}}']) { if (data['{{baseName}}']) {
this['{{baseName}}']{{{defaultValueWithParam}}} _this['{{baseName}}']{{{defaultValueWithParam}}}
} }
{{/vars}} {{/vars}}
return this; return _this;
} }
{{^omitModelMethods}} {{^omitModelMethods}}

3
samples/client/petstore/javascript-promise/src/ApiClient.js
View File

@ -250,8 +250,7 @@
default: default:
if (typeof type === 'function') { if (typeof type === 'function') {
// for model type like: User // for model type like: User
var model = new type(); var model = type.constructFromObject(data);
model.constructFromObject(data);
return model; return model;
} else if (Array.isArray(type)) { } else if (Array.isArray(type)) {
// for array type like: ['String'] // for array type like: ['String']

13
samples/client/petstore/javascript-promise/src/model/Category.js
View File

@ -33,23 +33,25 @@
}; };
Category.prototype.constructFromObject = function(data) { Category.constructFromObject = function(data) {
if (!data) { if (!data) {
return this; return null;
} }
var _this = new Category();
if (data['id']) { if (data['id']) {
this['id'] = ApiClient.convertToType(data['id'], 'Integer'); _this['id'] = ApiClient.convertToType(data['id'], 'Integer');
} }
if (data['name']) { if (data['name']) {
this['name'] = ApiClient.convertToType(data['name'], 'String'); _this['name'] = ApiClient.convertToType(data['name'], 'String');
} }
return this; return _this;
} }
/** /**
* @return {Integer} * @return {Integer}
**/ **/
@ -79,6 +81,7 @@
} }
Category.prototype.toJson = function() { Category.prototype.toJson = function() {
return JSON.stringify(this); return JSON.stringify(this);
} }

21
samples/client/petstore/javascript-promise/src/model/Order.js
View File

@ -82,39 +82,41 @@ var StatusEnum = function StatusEnum() {
}; };
Order.prototype.constructFromObject = function(data) { Order.constructFromObject = function(data) {
if (!data) { if (!data) {
return this; return null;
} }
var _this = new Order();
if (data['id']) { if (data['id']) {
this['id'] = ApiClient.convertToType(data['id'], 'Integer'); _this['id'] = ApiClient.convertToType(data['id'], 'Integer');
} }
if (data['petId']) { if (data['petId']) {
this['petId'] = ApiClient.convertToType(data['petId'], 'Integer'); _this['petId'] = ApiClient.convertToType(data['petId'], 'Integer');
} }
if (data['quantity']) { if (data['quantity']) {
this['quantity'] = ApiClient.convertToType(data['quantity'], 'Integer'); _this['quantity'] = ApiClient.convertToType(data['quantity'], 'Integer');
} }
if (data['shipDate']) { if (data['shipDate']) {
this['shipDate'] = ApiClient.convertToType(data['shipDate'], 'Date'); _this['shipDate'] = ApiClient.convertToType(data['shipDate'], 'Date');
} }
if (data['status']) { if (data['status']) {
this['status'] = ApiClient.convertToType(data['status'], 'String'); _this['status'] = ApiClient.convertToType(data['status'], 'String');
} }
if (data['complete']) { if (data['complete']) {
this['complete'] = ApiClient.convertToType(data['complete'], 'Boolean'); _this['complete'] = ApiClient.convertToType(data['complete'], 'Boolean');
} }
return this; return _this;
} }
/** /**
* @return {Integer} * @return {Integer}
**/ **/
@ -202,6 +204,7 @@ var StatusEnum = function StatusEnum() {
} }
Order.prototype.toJson = function() { Order.prototype.toJson = function() {
return JSON.stringify(this); return JSON.stringify(this);
} }

21
samples/client/petstore/javascript-promise/src/model/Pet.js
View File

@ -84,39 +84,41 @@ var StatusEnum = function StatusEnum() {
}; };
Pet.prototype.constructFromObject = function(data) { Pet.constructFromObject = function(data) {
if (!data) { if (!data) {
return this; return null;
} }
var _this = new Pet();
if (data['id']) { if (data['id']) {
this['id'] = ApiClient.convertToType(data['id'], 'Integer'); _this['id'] = ApiClient.convertToType(data['id'], 'Integer');
} }
if (data['category']) { if (data['category']) {
this['category'].constructFromObject(data['category']); _this['category'] = Category.constructFromObject(data['category']);
} }
if (data['name']) { if (data['name']) {
this['name'] = ApiClient.convertToType(data['name'], 'String'); _this['name'] = ApiClient.convertToType(data['name'], 'String');
} }
if (data['photoUrls']) { if (data['photoUrls']) {
this['photoUrls'] = ApiClient.convertToType(data['photoUrls'], ['String']); _this['photoUrls'] = ApiClient.convertToType(data['photoUrls'], ['String']);
} }
if (data['tags']) { if (data['tags']) {
this['tags'] = ApiClient.convertToType(data['tags'], [Tag]); _this['tags'] = ApiClient.convertToType(data['tags'], [Tag]);
} }
if (data['status']) { if (data['status']) {
this['status'] = ApiClient.convertToType(data['status'], 'String'); _this['status'] = ApiClient.convertToType(data['status'], 'String');
} }
return this; return _this;
} }
/** /**
* @return {Integer} * @return {Integer}
**/ **/
@ -204,6 +206,7 @@ var StatusEnum = function StatusEnum() {
} }
Pet.prototype.toJson = function() { Pet.prototype.toJson = function() {
return JSON.stringify(this); return JSON.stringify(this);
} }

13
samples/client/petstore/javascript-promise/src/model/Tag.js
View File

@ -33,23 +33,25 @@
}; };
Tag.prototype.constructFromObject = function(data) { Tag.constructFromObject = function(data) {
if (!data) { if (!data) {
return this; return null;
} }
var _this = new Tag();
if (data['id']) { if (data['id']) {
this['id'] = ApiClient.convertToType(data['id'], 'Integer'); _this['id'] = ApiClient.convertToType(data['id'], 'Integer');
} }
if (data['name']) { if (data['name']) {
this['name'] = ApiClient.convertToType(data['name'], 'String'); _this['name'] = ApiClient.convertToType(data['name'], 'String');
} }
return this; return _this;
} }
/** /**
* @return {Integer} * @return {Integer}
**/ **/
@ -79,6 +81,7 @@
} }
Tag.prototype.toJson = function() { Tag.prototype.toJson = function() {
return JSON.stringify(this); return JSON.stringify(this);
} }

25
samples/client/petstore/javascript-promise/src/model/User.js
View File

@ -64,47 +64,49 @@
}; };
User.prototype.constructFromObject = function(data) { User.constructFromObject = function(data) {
if (!data) { if (!data) {
return this; return null;
} }
var _this = new User();
if (data['id']) { if (data['id']) {
this['id'] = ApiClient.convertToType(data['id'], 'Integer'); _this['id'] = ApiClient.convertToType(data['id'], 'Integer');
} }
if (data['username']) { if (data['username']) {
this['username'] = ApiClient.convertToType(data['username'], 'String'); _this['username'] = ApiClient.convertToType(data['username'], 'String');
} }
if (data['firstName']) { if (data['firstName']) {
this['firstName'] = ApiClient.convertToType(data['firstName'], 'String'); _this['firstName'] = ApiClient.convertToType(data['firstName'], 'String');
} }
if (data['lastName']) { if (data['lastName']) {
this['lastName'] = ApiClient.convertToType(data['lastName'], 'String'); _this['lastName'] = ApiClient.convertToType(data['lastName'], 'String');
} }
if (data['email']) { if (data['email']) {
this['email'] = ApiClient.convertToType(data['email'], 'String'); _this['email'] = ApiClient.convertToType(data['email'], 'String');
} }
if (data['password']) { if (data['password']) {
this['password'] = ApiClient.convertToType(data['password'], 'String'); _this['password'] = ApiClient.convertToType(data['password'], 'String');
} }
if (data['phone']) { if (data['phone']) {
this['phone'] = ApiClient.convertToType(data['phone'], 'String'); _this['phone'] = ApiClient.convertToType(data['phone'], 'String');
} }
if (data['userStatus']) { if (data['userStatus']) {
this['userStatus'] = ApiClient.convertToType(data['userStatus'], 'Integer'); _this['userStatus'] = ApiClient.convertToType(data['userStatus'], 'Integer');
} }
return this; return _this;
} }
/** /**
* @return {Integer} * @return {Integer}
**/ **/
@ -220,6 +222,7 @@
} }
User.prototype.toJson = function() { User.prototype.toJson = function() {
return JSON.stringify(this); return JSON.stringify(this);
} }

3
samples/client/petstore/javascript/src/ApiClient.js
View File

@ -250,8 +250,7 @@
default: default:
if (typeof type === 'function') { if (typeof type === 'function') {
// for model type like: User // for model type like: User
var model = new type(); var model = type.constructFromObject(data);
model.constructFromObject(data);
return model; return model;
} else if (Array.isArray(type)) { } else if (Array.isArray(type)) {
// for array type like: ['String'] // for array type like: ['String']

13
samples/client/petstore/javascript/src/model/Category.js
View File

@ -33,23 +33,25 @@
}; };
Category.prototype.constructFromObject = function(data) { Category.constructFromObject = function(data) {
if (!data) { if (!data) {
return this; return null;
} }
var _this = new Category();
if (data['id']) { if (data['id']) {
this['id'] = ApiClient.convertToType(data['id'], 'Integer'); _this['id'] = ApiClient.convertToType(data['id'], 'Integer');
} }
if (data['name']) { if (data['name']) {
this['name'] = ApiClient.convertToType(data['name'], 'String'); _this['name'] = ApiClient.convertToType(data['name'], 'String');
} }
return this; return _this;
} }
/** /**
* @return {Integer} * @return {Integer}
**/ **/
@ -79,6 +81,7 @@
} }
Category.prototype.toJson = function() { Category.prototype.toJson = function() {
return JSON.stringify(this); return JSON.stringify(this);
} }

21
samples/client/petstore/javascript/src/model/Order.js
View File

@ -82,39 +82,41 @@ var StatusEnum = function StatusEnum() {
}; };
Order.prototype.constructFromObject = function(data) { Order.constructFromObject = function(data) {
if (!data) { if (!data) {
return this; return null;
} }
var _this = new Order();
if (data['id']) { if (data['id']) {
this['id'] = ApiClient.convertToType(data['id'], 'Integer'); _this['id'] = ApiClient.convertToType(data['id'], 'Integer');
} }
if (data['petId']) { if (data['petId']) {
this['petId'] = ApiClient.convertToType(data['petId'], 'Integer'); _this['petId'] = ApiClient.convertToType(data['petId'], 'Integer');
} }
if (data['quantity']) { if (data['quantity']) {
this['quantity'] = ApiClient.convertToType(data['quantity'], 'Integer'); _this['quantity'] = ApiClient.convertToType(data['quantity'], 'Integer');
} }
if (data['shipDate']) { if (data['shipDate']) {
this['shipDate'] = ApiClient.convertToType(data['shipDate'], 'Date'); _this['shipDate'] = ApiClient.convertToType(data['shipDate'], 'Date');
} }
if (data['status']) { if (data['status']) {
this['status'] = ApiClient.convertToType(data['status'], 'String'); _this['status'] = ApiClient.convertToType(data['status'], 'String');
} }
if (data['complete']) { if (data['complete']) {
this['complete'] = ApiClient.convertToType(data['complete'], 'Boolean'); _this['complete'] = ApiClient.convertToType(data['complete'], 'Boolean');
} }
return this; return _this;
} }
/** /**
* @return {Integer} * @return {Integer}
**/ **/
@ -202,6 +204,7 @@ var StatusEnum = function StatusEnum() {
} }
Order.prototype.toJson = function() { Order.prototype.toJson = function() {
return JSON.stringify(this); return JSON.stringify(this);
} }

21
samples/client/petstore/javascript/src/model/Pet.js
View File

@ -84,39 +84,41 @@ var StatusEnum = function StatusEnum() {
}; };
Pet.prototype.constructFromObject = function(data) { Pet.constructFromObject = function(data) {
if (!data) { if (!data) {
return this; return null;
} }
var _this = new Pet();
if (data['id']) { if (data['id']) {
this['id'] = ApiClient.convertToType(data['id'], 'Integer'); _this['id'] = ApiClient.convertToType(data['id'], 'Integer');
} }
if (data['category']) { if (data['category']) {
this['category'].constructFromObject(data['category']); _this['category'] = Category.constructFromObject(data['category']);
} }
if (data['name']) { if (data['name']) {
this['name'] = ApiClient.convertToType(data['name'], 'String'); _this['name'] = ApiClient.convertToType(data['name'], 'String');
} }
if (data['photoUrls']) { if (data['photoUrls']) {
this['photoUrls'] = ApiClient.convertToType(data['photoUrls'], ['String']); _this['photoUrls'] = ApiClient.convertToType(data['photoUrls'], ['String']);
} }
if (data['tags']) { if (data['tags']) {
this['tags'] = ApiClient.convertToType(data['tags'], [Tag]); _this['tags'] = ApiClient.convertToType(data['tags'], [Tag]);
} }
if (data['status']) { if (data['status']) {
this['status'] = ApiClient.convertToType(data['status'], 'String'); _this['status'] = ApiClient.convertToType(data['status'], 'String');
} }
return this; return _this;
} }
/** /**
* @return {Integer} * @return {Integer}
**/ **/
@ -204,6 +206,7 @@ var StatusEnum = function StatusEnum() {
} }
Pet.prototype.toJson = function() { Pet.prototype.toJson = function() {
return JSON.stringify(this); return JSON.stringify(this);
} }

13
samples/client/petstore/javascript/src/model/Tag.js
View File

@ -33,23 +33,25 @@
}; };
Tag.prototype.constructFromObject = function(data) { Tag.constructFromObject = function(data) {
if (!data) { if (!data) {
return this; return null;
} }
var _this = new Tag();
if (data['id']) { if (data['id']) {
this['id'] = ApiClient.convertToType(data['id'], 'Integer'); _this['id'] = ApiClient.convertToType(data['id'], 'Integer');
} }
if (data['name']) { if (data['name']) {
this['name'] = ApiClient.convertToType(data['name'], 'String'); _this['name'] = ApiClient.convertToType(data['name'], 'String');
} }
return this; return _this;
} }
/** /**
* @return {Integer} * @return {Integer}
**/ **/
@ -79,6 +81,7 @@
} }
Tag.prototype.toJson = function() { Tag.prototype.toJson = function() {
return JSON.stringify(this); return JSON.stringify(this);
} }

25
samples/client/petstore/javascript/src/model/User.js
View File

@ -64,47 +64,49 @@
}; };
User.prototype.constructFromObject = function(data) { User.constructFromObject = function(data) {
if (!data) { if (!data) {
return this; return null;
} }
var _this = new User();
if (data['id']) { if (data['id']) {
this['id'] = ApiClient.convertToType(data['id'], 'Integer'); _this['id'] = ApiClient.convertToType(data['id'], 'Integer');
} }
if (data['username']) { if (data['username']) {
this['username'] = ApiClient.convertToType(data['username'], 'String'); _this['username'] = ApiClient.convertToType(data['username'], 'String');
} }
if (data['firstName']) { if (data['firstName']) {
this['firstName'] = ApiClient.convertToType(data['firstName'], 'String'); _this['firstName'] = ApiClient.convertToType(data['firstName'], 'String');
} }
if (data['lastName']) { if (data['lastName']) {
this['lastName'] = ApiClient.convertToType(data['lastName'], 'String'); _this['lastName'] = ApiClient.convertToType(data['lastName'], 'String');
} }
if (data['email']) { if (data['email']) {
this['email'] = ApiClient.convertToType(data['email'], 'String'); _this['email'] = ApiClient.convertToType(data['email'], 'String');
} }
if (data['password']) { if (data['password']) {
this['password'] = ApiClient.convertToType(data['password'], 'String'); _this['password'] = ApiClient.convertToType(data['password'], 'String');
} }
if (data['phone']) { if (data['phone']) {
this['phone'] = ApiClient.convertToType(data['phone'], 'String'); _this['phone'] = ApiClient.convertToType(data['phone'], 'String');
} }
if (data['userStatus']) { if (data['userStatus']) {
this['userStatus'] = ApiClient.convertToType(data['userStatus'], 'Integer'); _this['userStatus'] = ApiClient.convertToType(data['userStatus'], 'Integer');
} }
return this; return _this;
} }
/** /**
* @return {Integer} * @return {Integer}
**/ **/
@ -220,6 +222,7 @@
} }
User.prototype.toJson = function() { User.prototype.toJson = function() {
return JSON.stringify(this); return JSON.stringify(this);
} }