Skip to content

[Swift3] allow POST with both body and query parameters #4490

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 2 commits into from
Jan 7, 2017
Merged

[Swift3] allow POST with both body and query parameters #4490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
819f554
[swift3] allow POST with both body and query parameters
Jan 4, 2017
5e6adac
Correctly support non-string and optional query parameters.
Jan 5, 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
27 changes: 23 additions & 4 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,6 +16,15 @@ 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 @@ -108,20 +117,30 @@ open class {{classname}}: APIBase {
path = path.replacingOccurrences(of: "{{=<% %>=}}{<%paramName%>}<%={{ }}=%>", with: "\({{paramName}}{{#isEnum}}{{#isContainer}}{{{dataType}}}{{/isContainer}}{{^isContainer}}.rawValue{{/isContainer}}{{/isEnum}})", options: .literal, range: nil){{/pathParams}}
let URLString = {{projectName}}API.basePath + path
{{#bodyParam}}
let parameters = {{paramName}}{{^required}}?{{/required}}.encodeToJSON() as? [String:AnyObject]{{/bodyParam}}{{^bodyParam}}
let parameters = {{paramName}}{{^required}}?{{/required}}.encodeToJSON() as? [String:AnyObject]

let url = NSURLComponents(string: URLString)
{{#hasQueryParams}}
url?.queryItems = 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: URLString, parameters: convertedParameters, isBody: {{^queryParams}}{{^formParams}}true{{/formParams}}{{/queryParams}}{{#queryParams}}{{^formParams}}{{^secondaryParam}}false{{/secondaryParam}}{{/formParams}}{{/queryParams}}{{#formParams}}{{^secondaryParam}}false{{/secondaryParam}}{{/formParams}})
return requestBuilder.init(method: "{{httpMethod}}", URLString: {{#bodyParam}}(url?.string ?? URLString){{/bodyParam}}{{^bodyParam}}URLString{{/bodyParam}}, parameters: convertedParameters, isBody: {{hasBodyParam}})
}

{{/operation}}
Expand Down
28 changes: 21 additions & 7 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,6 +10,15 @@ 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 All @@ -26,6 +35,7 @@ open class FakeAPI: APIBase {
/**
To test \"client\" model
- PATCH /fake
- To test \"client\" model
- examples: [{contentType=application/json, example={
"client" : "aeiou"
}}]
Expand All @@ -38,12 +48,15 @@ open class FakeAPI: APIBase {
let path = "/fake"
let URLString = PetstoreClientAPI.basePath + path
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: URLString, parameters: convertedParameters, isBody: true)
return requestBuilder.init(method: "PATCH", URLString: (url?.string ?? URLString), parameters: convertedParameters, isBody: true)
}

/**
Expand Down Expand Up @@ -119,9 +132,9 @@ open class FakeAPI: APIBase {
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)

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

return requestBuilder.init(method: "POST", URLString: URLString, parameters: convertedParameters, isBody: false)
Expand Down Expand Up @@ -182,6 +195,7 @@ open class FakeAPI: APIBase {
/**
To test enum parameters
- GET /fake
- To test enum parameters

- parameter enumFormStringArray: (form) Form parameter enum test (string array) (optional)
- parameter enumFormString: (form) Form parameter enum test (string) (optional, default to -efg)
Expand All @@ -203,9 +217,9 @@ open class FakeAPI: APIBase {
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)

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

return requestBuilder.init(method: "GET", URLString: URLString, parameters: convertedParameters, isBody: false)
Expand Down
55 changes: 35 additions & 20 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,6 +10,15 @@ 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 @@ -39,12 +48,15 @@ open class PetAPI: APIBase {
let path = "/pet"
let URLString = PetstoreClientAPI.basePath + path
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: URLString, parameters: convertedParameters, isBody: true)
return requestBuilder.init(method: "POST", URLString: (url?.string ?? URLString), parameters: convertedParameters, isBody: true)
}

/**
Expand Down Expand Up @@ -80,12 +92,12 @@ open class PetAPI: APIBase {
let nillableParameters: [String:Any?] = [:]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)

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

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

/**
Expand Down Expand Up @@ -177,9 +189,9 @@ open class PetAPI: APIBase {
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)

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

return requestBuilder.init(method: "GET", URLString: URLString, parameters: convertedParameters, isBody: false)
Expand Down Expand Up @@ -265,9 +277,9 @@ open class PetAPI: APIBase {
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)

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

return requestBuilder.init(method: "GET", URLString: URLString, parameters: convertedParameters, isBody: false)
Expand Down Expand Up @@ -352,12 +364,12 @@ open class PetAPI: APIBase {
let nillableParameters: [String:Any?] = [:]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)

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

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

/**
Expand Down Expand Up @@ -389,12 +401,15 @@ open class PetAPI: APIBase {
let path = "/pet"
let URLString = PetstoreClientAPI.basePath + path
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: URLString, parameters: convertedParameters, isBody: true)
return requestBuilder.init(method: "PUT", URLString: (url?.string ?? URLString), parameters: convertedParameters, isBody: true)
}

/**
Expand Down Expand Up @@ -437,9 +452,9 @@ open class PetAPI: APIBase {
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)

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

return requestBuilder.init(method: "POST", URLString: URLString, parameters: convertedParameters, isBody: false)
Expand Down Expand Up @@ -490,9 +505,9 @@ open class PetAPI: APIBase {
]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)

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

return requestBuilder.init(method: "POST", URLString: URLString, parameters: convertedParameters, isBody: false)
Expand Down
36 changes: 24 additions & 12 deletions samples/client/petstore/swift3/default/PetstoreClient/Classes/Swaggers/APIs/StoreAPI.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ import Alamofire


open class StoreAPI: 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!)")
}
}

/**
Delete purchase order by ID

Expand Down Expand Up @@ -40,12 +49,12 @@ open class StoreAPI: APIBase {
let nillableParameters: [String:Any?] = [:]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)

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

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

/**
Expand Down Expand Up @@ -80,12 +89,12 @@ open class StoreAPI: APIBase {
let nillableParameters: [String:Any?] = [:]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)

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

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

/**
Expand Down Expand Up @@ -148,12 +157,12 @@ open class StoreAPI: APIBase {
let nillableParameters: [String:Any?] = [:]

let parameters = APIHelper.rejectNil(nillableParameters)

let convertedParameters = APIHelper.convertBoolToString(parameters)

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

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

/**
Expand Down Expand Up @@ -212,12 +221,15 @@ open class StoreAPI: APIBase {
let path = "/store/order"
let URLString = PetstoreClientAPI.basePath + path
let parameters = body.encodeToJSON() as? [String:AnyObject]


let url = NSURLComponents(string: URLString)


let convertedParameters = APIHelper.convertBoolToString(parameters)

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

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

}
Loading