Skip to content

[Swift3] Cleaner template of client methods #4552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 3 commits into from
Jan 15, 2017
Merged

[Swift3] Cleaner template of client methods #4552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d06651
Swift3 template properly uploads files, making mustache template litt…
Jan 12, 2017
e5c4e0b
[swift3] moved URL parameter encoder helper function to APIHelper.swift
Jan 12, 2017
a9fdb74
Swift3 - regenerated sample
Jan 12, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions modules/swagger-codegen/src/main/resources/swift3/APIHelper.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,13 @@ class APIHelper {
return destination
}


static func mapValuesToQueryItems(values: [String:Any?]) -> [URLQueryItem] {
return values
.filter { $0.1 != nil }
.map { (item: (_key: String, _value: Any?)) -> URLQueryItem in
URLQueryItem(name: item._key, value:"\(item._value!)")
}
}

}
39 changes: 18 additions & 21 deletions modules/swagger-codegen/src/main/resources/swift3/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,6 @@ extension {{projectName}}API {
{{#description}}
/** {{description}} */{{/description}}
open class {{classname}}: APIBase {

public class func mapValuesToQueryItems(values: [String:Any?]) -> [URLQueryItem] {
return values
.filter { $0.1 != nil }
.map { (item: (_key: String, _value: Any?)) -> URLQueryItem in
URLQueryItem(name: item._key, value:"\(item._value!)")
}
}

{{#operation}}
{{#allParams}}
{{#isEnum}}
Expand Down Expand Up @@ -118,29 +109,35 @@ open class {{classname}}: APIBase {
let URLString = {{projectName}}API.basePath + path
{{#bodyParam}}
let parameters = {{paramName}}{{^required}}?{{/required}}.encodeToJSON() as? [String:AnyObject]
{{/bodyParam}}
{{^bodyParam}}
{{#hasFormParams}}
let formParams: [String:Any?] = [
{{#formParams}}
{{> _param}}{{#hasMore}},{{/hasMore}}
{{/formParams}}
]

let nonNullParameters = APIHelper.rejectNil(formParams)
let parameters = APIHelper.convertBoolToString(nonNullParameters)
{{/hasFormParams}}
{{^hasFormParams}}
let parameters: [String:Any]? = nil
{{/hasFormParams}}
{{/bodyParam}}

let url = NSURLComponents(string: URLString)
{{#hasQueryParams}}
url?.queryItems = mapValuesToQueryItems(values:[
url?.queryItems = APIHelper.mapValuesToQueryItems(values:[
{{#queryParams}}
"{{paramName}}": {{paramName}}{{#hasMore}}, {{/hasMore}}
{{/queryParams}}
])
{{/hasQueryParams}}
{{/bodyParam}}{{^bodyParam}}
let nillableParameters: [String:Any?] = {{^queryParams}}{{^formParams}}[:]{{/formParams}}{{#formParams}}{{^secondaryParam}}[{{/secondaryParam}}
{{> _param}}{{#hasMore}},{{/hasMore}}{{^hasMore}}
]{{/hasMore}}{{/formParams}}{{/queryParams}}{{#queryParams}}{{^secondaryParam}}[{{/secondaryParam}}
{{> _param}}{{#hasMore}},{{/hasMore}}{{^hasMore}}
]{{/hasMore}}{{/queryParams}}

let parameters = APIHelper.rejectNil(nillableParameters){{/bodyParam}}

let convertedParameters = APIHelper.convertBoolToString(parameters)

let requestBuilder: RequestBuilder<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}>.Type = {{projectName}}API.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "{{httpMethod}}", URLString: {{#bodyParam}}(url?.string ?? URLString){{/bodyParam}}{{^bodyParam}}URLString{{/bodyParam}}, parameters: convertedParameters, isBody: {{hasBodyParam}})
return requestBuilder.init(method: "{{httpMethod}}", URLString: (url?.string ?? URLString), parameters: parameters, isBody: {{hasBodyParam}})
}

{{/operation}}
Expand Down
9 changes: 9 additions & 0 deletions samples/client/petstore/swift3/default/PetstoreClient/Classes/Swaggers/APIHelper.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,13 @@ class APIHelper {
return destination
}


static func mapValuesToQueryItems(values: [String:Any?]) -> [URLQueryItem] {
return values
.filter { $0.1 != nil }
.map { (item: (_key: String, _value: Any?)) -> URLQueryItem in
URLQueryItem(name: item._key, value:"\(item._value!)")
}
}

}
49 changes: 21 additions & 28 deletions samples/client/petstore/swift3/default/PetstoreClient/Classes/Swaggers/APIs/FakeAPI.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,6 @@ import Alamofire


open class FakeAPI: APIBase {

public class func mapValuesToQueryItems(values: [String:Any?]) -> [URLQueryItem] {
return values
.filter { $0.1 != nil }
.map { (item: (_key: String, _value: Any?)) -> URLQueryItem in
URLQueryItem(name: item._key, value:"\(item._value!)")
}
}

/**
To test \"client\" model

Expand Down Expand Up @@ -50,13 +41,10 @@ open class FakeAPI: APIBase {
let parameters = body.encodeToJSON() as? [String:AnyObject]

let url = NSURLComponents(string: URLString)


let convertedParameters = APIHelper.convertBoolToString(parameters)

let requestBuilder: RequestBuilder<Client>.Type = PetstoreClientAPI.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "PATCH", URLString: (url?.string ?? URLString), parameters: convertedParameters, isBody: true)
return requestBuilder.init(method: "PATCH", URLString: (url?.string ?? URLString), parameters: parameters, isBody: true)
}

/**
Expand Down Expand Up @@ -113,8 +101,7 @@ open class FakeAPI: APIBase {
open class func testEndpointParametersWithRequestBuilder(number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int32? = nil, int32: Int32? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: Data? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil) -> RequestBuilder<Void> {
let path = "/fake"
let URLString = PetstoreClientAPI.basePath + path

let nillableParameters: [String:Any?] = [
let formParams: [String:Any?] = [
"integer": integer?.encodeToJSON(),
"int32": int32?.encodeToJSON(),
"int64": int64?.encodeToJSON(),
Expand All @@ -130,14 +117,15 @@ open class FakeAPI: APIBase {
"password": password,
"callback": callback
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)
let nonNullParameters = APIHelper.rejectNil(formParams)
let parameters = APIHelper.convertBoolToString(nonNullParameters)

let url = NSURLComponents(string: URLString)

let requestBuilder: RequestBuilder<Void>.Type = PetstoreClientAPI.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "POST", URLString: URLString, parameters: convertedParameters, isBody: false)
return requestBuilder.init(method: "POST", URLString: (url?.string ?? URLString), parameters: parameters, isBody: false)
}

/**
Expand Down Expand Up @@ -209,20 +197,25 @@ open class FakeAPI: APIBase {
open class func testEnumParametersWithRequestBuilder(enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: Int32? = nil, enumQueryDouble: Double? = nil) -> RequestBuilder<Void> {
let path = "/fake"
let URLString = PetstoreClientAPI.basePath + path

let nillableParameters: [String:Any?] = [
"enum_query_string_array": enumQueryStringArray,
"enum_query_string": enumQueryString?.rawValue,
"enum_query_integer": enumQueryInteger?.encodeToJSON()
let formParams: [String:Any?] = [
"enum_form_string_array": enumFormStringArray,
"enum_form_string": enumFormString?.rawValue,
"enum_query_double": enumQueryDouble
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)
let nonNullParameters = APIHelper.rejectNil(formParams)
let parameters = APIHelper.convertBoolToString(nonNullParameters)

let url = NSURLComponents(string: URLString)
url?.queryItems = APIHelper.mapValuesToQueryItems(values:[
"enumQueryStringArray": enumQueryStringArray,
"enumQueryString": enumQueryString,
"enumQueryInteger": enumQueryInteger
])

let requestBuilder: RequestBuilder<Void>.Type = PetstoreClientAPI.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "GET", URLString: URLString, parameters: convertedParameters, isBody: false)
return requestBuilder.init(method: "GET", URLString: (url?.string ?? URLString), parameters: parameters, isBody: false)
}

}
89 changes: 32 additions & 57 deletions samples/client/petstore/swift3/default/PetstoreClient/Classes/Swaggers/APIs/PetAPI.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,6 @@ import Alamofire


open class PetAPI: APIBase {

public class func mapValuesToQueryItems(values: [String:Any?]) -> [URLQueryItem] {
return values
.filter { $0.1 != nil }
.map { (item: (_key: String, _value: Any?)) -> URLQueryItem in
URLQueryItem(name: item._key, value:"\(item._value!)")
}
}

/**
Add a new pet to the store

Expand Down Expand Up @@ -50,13 +41,10 @@ open class PetAPI: APIBase {
let parameters = body.encodeToJSON() as? [String:AnyObject]

let url = NSURLComponents(string: URLString)


let convertedParameters = APIHelper.convertBoolToString(parameters)

let requestBuilder: RequestBuilder<Void>.Type = PetstoreClientAPI.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "POST", URLString: (url?.string ?? URLString), parameters: convertedParameters, isBody: true)
return requestBuilder.init(method: "POST", URLString: (url?.string ?? URLString), parameters: parameters, isBody: true)
}

/**
Expand Down Expand Up @@ -88,16 +76,13 @@ open class PetAPI: APIBase {
var path = "/pet/{petId}"
path = path.replacingOccurrences(of: "{petId}", with: "\(petId)", options: .literal, range: nil)
let URLString = PetstoreClientAPI.basePath + path
let parameters: [String:Any]? = nil

let nillableParameters: [String:Any?] = [:]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)
let url = NSURLComponents(string: URLString)

let requestBuilder: RequestBuilder<Void>.Type = PetstoreClientAPI.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "DELETE", URLString: URLString, parameters: convertedParameters, isBody: false)
return requestBuilder.init(method: "DELETE", URLString: (url?.string ?? URLString), parameters: parameters, isBody: false)
}

/**
Expand Down Expand Up @@ -183,18 +168,16 @@ open class PetAPI: APIBase {
open class func findPetsByStatusWithRequestBuilder(status: [String]) -> RequestBuilder<[Pet]> {
let path = "/pet/findByStatus"
let URLString = PetstoreClientAPI.basePath + path
let parameters: [String:Any]? = nil

let nillableParameters: [String:Any?] = [
"status": status
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)
let url = NSURLComponents(string: URLString)
url?.queryItems = APIHelper.mapValuesToQueryItems(values:[
"status": status
])

let requestBuilder: RequestBuilder<[Pet]>.Type = PetstoreClientAPI.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "GET", URLString: URLString, parameters: convertedParameters, isBody: false)
return requestBuilder.init(method: "GET", URLString: (url?.string ?? URLString), parameters: parameters, isBody: false)
}

/**
Expand Down Expand Up @@ -271,18 +254,16 @@ open class PetAPI: APIBase {
open class func findPetsByTagsWithRequestBuilder(tags: [String]) -> RequestBuilder<[Pet]> {
let path = "/pet/findByTags"
let URLString = PetstoreClientAPI.basePath + path
let parameters: [String:Any]? = nil

let nillableParameters: [String:Any?] = [
"tags": tags
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)
let url = NSURLComponents(string: URLString)
url?.queryItems = APIHelper.mapValuesToQueryItems(values:[
"tags": tags
])

let requestBuilder: RequestBuilder<[Pet]>.Type = PetstoreClientAPI.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "GET", URLString: URLString, parameters: convertedParameters, isBody: false)
return requestBuilder.init(method: "GET", URLString: (url?.string ?? URLString), parameters: parameters, isBody: false)
}

/**
Expand Down Expand Up @@ -360,16 +341,13 @@ open class PetAPI: APIBase {
var path = "/pet/{petId}"
path = path.replacingOccurrences(of: "{petId}", with: "\(petId)", options: .literal, range: nil)
let URLString = PetstoreClientAPI.basePath + path
let parameters: [String:Any]? = nil

let nillableParameters: [String:Any?] = [:]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)
let url = NSURLComponents(string: URLString)

let requestBuilder: RequestBuilder<Pet>.Type = PetstoreClientAPI.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "GET", URLString: URLString, parameters: convertedParameters, isBody: false)
return requestBuilder.init(method: "GET", URLString: (url?.string ?? URLString), parameters: parameters, isBody: false)
}

/**
Expand Down Expand Up @@ -403,13 +381,10 @@ open class PetAPI: APIBase {
let parameters = body.encodeToJSON() as? [String:AnyObject]

let url = NSURLComponents(string: URLString)


let convertedParameters = APIHelper.convertBoolToString(parameters)

let requestBuilder: RequestBuilder<Void>.Type = PetstoreClientAPI.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "PUT", URLString: (url?.string ?? URLString), parameters: convertedParameters, isBody: true)
return requestBuilder.init(method: "PUT", URLString: (url?.string ?? URLString), parameters: parameters, isBody: true)
}

/**
Expand Down Expand Up @@ -445,19 +420,19 @@ open class PetAPI: APIBase {
var path = "/pet/{petId}"
path = path.replacingOccurrences(of: "{petId}", with: "\(petId)", options: .literal, range: nil)
let URLString = PetstoreClientAPI.basePath + path

let nillableParameters: [String:Any?] = [
let formParams: [String:Any?] = [
"name": name,
"status": status
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)
let nonNullParameters = APIHelper.rejectNil(formParams)
let parameters = APIHelper.convertBoolToString(nonNullParameters)

let url = NSURLComponents(string: URLString)

let requestBuilder: RequestBuilder<Void>.Type = PetstoreClientAPI.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "POST", URLString: URLString, parameters: convertedParameters, isBody: false)
return requestBuilder.init(method: "POST", URLString: (url?.string ?? URLString), parameters: parameters, isBody: false)
}

/**
Expand Down Expand Up @@ -498,19 +473,19 @@ open class PetAPI: APIBase {
var path = "/pet/{petId}/uploadImage"
path = path.replacingOccurrences(of: "{petId}", with: "\(petId)", options: .literal, range: nil)
let URLString = PetstoreClientAPI.basePath + path

let nillableParameters: [String:Any?] = [
let formParams: [String:Any?] = [
"additionalMetadata": additionalMetadata,
"file": file
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)
let nonNullParameters = APIHelper.rejectNil(formParams)
let parameters = APIHelper.convertBoolToString(nonNullParameters)

let url = NSURLComponents(string: URLString)

let requestBuilder: RequestBuilder<ApiResponse>.Type = PetstoreClientAPI.requestBuilderFactory.getBuilder()

return requestBuilder.init(method: "POST", URLString: URLString, parameters: convertedParameters, isBody: false)
return requestBuilder.init(method: "POST", URLString: (url?.string ?? URLString), parameters: parameters, isBody: false)
}

}
Loading