[Golang] Generated client trying to unmarshal non-existent JSON into an **os.File

[mmellar]

Hi Folks, pretty new to Swagger so not sure if this is a bug or if I'm just being a dolt...

Description

I have the following endpoint definition, intended to just serve some tar file...

/{service}/{account}/{dsid}:
  get:
      summary: Retrieve an archive
      description: Retrieve an archive
      produces:
        - application/x-tar
      parameters:
        - name: service
          in: path
          description: Service archive resides in
          required: true
          type: string
        - name: account
          in: path
          description: Account archive is registered with
          required: true
          type: string
        - name: dsid
          in: path
          description: Archive Id
          required: true
          type: string
      responses:
        200:
          description: An archive
          schema:
            type: file
        404:
          description: Archive could not be found.

Generated server code fine, my handler just boils down to this...

func (h *Handlers) GetDataset(res http.ResponseWriter, req *http.Request) {
	path := "." + req.URL.Path
	http.ServeFile(res, req, path)
}

I know there are security issues, keeping it simple for now. The server endpoint works fine with curl.

Unfortunately, I'm having trouble with generating client code for accessing this endpoint. Here's what the generator gives me...

func (a DefaultApi) ServiceAccountDsidGet(service string, account string, dsid string) (**os.File, *APIResponse, error) {

	var localVarHttpMethod = strings.ToUpper("Get")
	// create path and map variables
	localVarPath := a.Configuration.BasePath + "/{service}/{account}/{dsid}"
	localVarPath = strings.Replace(localVarPath, "{"+"service"+"}", fmt.Sprintf("%v", service), -1)
	localVarPath = strings.Replace(localVarPath, "{"+"account"+"}", fmt.Sprintf("%v", account), -1)
	localVarPath = strings.Replace(localVarPath, "{"+"dsid"+"}", fmt.Sprintf("%v", dsid), -1)

	localVarHeaderParams := make(map[string]string)
	localVarQueryParams := url.Values{}
	localVarFormParams := make(map[string]string)
	var localVarPostBody interface{}
	var localVarFileName string
	var localVarFileBytes []byte
	// add default headers if any
	for key := range a.Configuration.DefaultHeader {
		localVarHeaderParams[key] = a.Configuration.DefaultHeader[key]
	}

	// to determine the Content-Type header
	localVarHttpContentTypes := []string{}

	// set Content-Type header
	localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes)
	if localVarHttpContentType != "" {
		localVarHeaderParams["Content-Type"] = localVarHttpContentType
	}
	// to determine the Accept header
	localVarHttpHeaderAccepts := []string{}

	// set Accept header
	localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts)
	if localVarHttpHeaderAccept != "" {
		localVarHeaderParams["Accept"] = localVarHttpHeaderAccept
	}
	var successPayload = new(*os.File)
	localVarHttpResponse, err := a.Configuration.APIClient.CallAPI(localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes)

	var localVarURL, _ = url.Parse(localVarPath)
	localVarURL.RawQuery = localVarQueryParams.Encode()
	var localVarAPIResponse = &APIResponse{Operation: "ServiceAccountDsidGet", Method: localVarHttpMethod, RequestURL: localVarURL.String()}
	if localVarHttpResponse != nil {
		localVarAPIResponse.Response = localVarHttpResponse.RawResponse
		localVarAPIResponse.Payload = localVarHttpResponse.Body()
	}

	if err != nil {
		return successPayload, localVarAPIResponse, err
	}
	err = json.Unmarshal(localVarHttpResponse.Body(), &successPayload)
	return successPayload, localVarAPIResponse, err
}

This consistently fails because of the second to last line. The response body does not contain JSON, it's just file data, therefore it doesn't make sense to try unmarshaling it into the return value. No matter how I fiddle with my definition, I can't seem to convince the generator that the body data shouldn't be JSON.

So, am I coming at this the wrong way, or is there something up with the templates?

Thanks!

Mark

Swagger-codegen version

Generated using swagger editor 2.10.3

[wing328]

@mmellar thanks for reporting the issue. I don't think we've added support for file response type to Go client yet.

May I know if you've time to contribute the enhancement? If yes, I can show you some good starting points.

[mmellar]

Thanks for your response!

I can't commit to contributing as I've no reference point to how long it'll take. That said I can certainly take a look if you'd be kind enough to point me at the right bits of the codebase.

I've also taken a look at (I.E. read but not executed) client code generated in Perl and Javascript and they seem to have the same issue. Has this functionality been implemented for any language yet?

Cheers,

Mark.

[0xfede7c8]

Is there any progress about this? I found the same issue which is annoying.