[Swift] generated ClientSDK - excute callback response type

[junyun0516]

Are using Swagger codegen, when the execute, request to API (in my case UserAPI) looks like can only model that is mapped to.
There is no problem if http code is 200, when receiving the other StatusCode, if the model is the return comes to the other model (in my case Error) could only given model when you request excute it troubled they become.
Do you not allow you to specify each type made of a excute?
Well I want to use. help me.

[inska]

Hi @wing328,

@junyun0516 works with me and additional phenomenon would be help. Our YAML file includes below:

  responses:
    '200':
      description: User info
      schema:
        $ref: '#/definitions/User'
    '400':
      description: Error
      schema:
        $ref: '#/definitions/Error'

definitions:
Error:
type: object
required:
- reason
properties:
reason:
type: string
User:
type: object
required:
- id
properties:
id:
type: integer
format: int64
api_token:
type: string

Swagger Client for Swift works well when sever returns with status code 200, but when returns 400, client seems can't get Error object. I don't have experience with Swift so this would be problem of own code, but @junyun0516 is in trouble with client.

Ruby or Python clients work well with above YAML when server returns 400 or others like as response object contains status code and response body.

Is there any way to handling return object following status code?

Best Regards,
Inska

[wing328]

@junyun0516 would suggest you guys to pull the latest master if you guys have not done so as recently there are a few PRs to enhancement the Swift client.

[inska]

@wing328, just pulled master, run "mvn install", and re-generate swift client. However, above situation not resolved..

[wing328]

@inska thanks for performing more tests with the latest master. I'm afraid more works need to be done to improve the exceptions handling in Swift client.

One suggestion is to create an ApiException object (which extends the basic Exception object) in Swift to capture the HTTP status code, header, body, etc similar to how other languages capture exceptions (4xx, 5xx):

• https://github.com/swagger-api/swagger-codegen/blob/master/samples/client/petstore/php/SwaggerClient-php/lib/ApiException.php
• https://github.com/swagger-api/swagger-codegen/blob/master/samples/client/petstore/java/default/src/main/java/io/swagger/client/ApiException.java

(not sure if Swift has similar mechanism for error handling)

cc @jaz-ah who has recently made a lot of contribution to the Swift client.

[jaz-ah]

yeah the error handling isn't too great - right now I have added code in my local branch to AlamofireImplementations.swift right after request.responseJSON that grabs any error > 400 and returns that in the promise's error - you don't get any custom error objects but at least you get an NSError that describes the url/statuscode that hit the error...

        // AlamoFire doesn't automatically check status responses for error codes
        // so we do it manually here - also we could call validate() on the AlamoFire
        // request but it doesn't put the status code in the error message
        // which isn't too helpful in the client code
        if request.response?.statusCode >= 400 {
            let error = NSError(domain: (request.response?.URL?.URLString)!, code: (request.response?.statusCode)!, userInfo: nil)
            error.log()
            completion(response: nil, error: error)
            return
        }

this still doesn't solve the custom error handling though - but that would be the place to modify the code to add it...

[wing328]

@jaz-ah do you mind submitting a PR for the solution you proposed?

[jaz-ah]

@wing328 sure I can push a change in this week.