[GOLANG] Bug. Client codegen Post Body

[stephenrlouie]

Description

The issue here revolves around golang client generated code and having an untyped json expected in the body. The codegen will set the varLocalPostBody = &body, and body interface{}, so internally we will pass around the memory address of body instead of its contents. This causes client error: Unsupported 'Body' type/value when I attempt to pass a struct into the POST endpoint defined.

Swagger-codegen version

2.2.0. I'm calling via this jimschubert container

Swagger declaration file content or url

post:
      description: submitting a new JSON
      operationId: postJSON
      parameters:
        - in: body
          name: body
          description: JSON
          required: true
          schema:
            type: object
      responses:
        200:
          description: received Raw JSON

Command line used for generation

where the v1.yaml is my swagger spec

clientconfig.json is

{
  "packageName": "apiclient",
  "packageVersion": "1.0"
}

docker run -it -v $(pwd):/swag \
	          jimschubert/swagger-codegen-cli generate \
	          -i /swag/v1.yaml \
	          -l go \
	          -o /swag/out/api/client \
	          -c /swag/clientconfig.json

Steps to reproduce

1. Specify a POST endpoint that takes untyped JSON
2. Codegen
3. Call the default_api.go function for that post. It should take interface{}
4. See the client error: Unsupported 'Body' type/value

*I've also see the &body code if I specify a type integer

Related issues

Suggest a Fix

Pass around the actual contents of the interface {}

s/&body/body

[antihax]

Could you try 2.3.0? I think this was resolved.

[antihax]

Still present.

[luism6n]

Is this still present? I tried to reproduce with the following steps.

YAML file:

# problematic.yaml
swagger: "2.0"
info:
  version: 1.0.0
  title: Untyped JSON
paths:
  /:
    post:
      description: submitting a new JSON
      operationId: postJSON
      parameters:
        - in: body
          name: body
          description: JSON
          required: true
          schema:
            type: object
      responses:
        200:
          description: received Raw JSON

Generate the client code and link to the Go path:

$ ./run-in-docker.sh generate -i problematic.yaml -l go -o /gen/out/problematic -DpackageName=problematic
$ ln -s ${PWD}/out/ $(go env GOPATH)/src/out

Write the Go test code:

package main

import (
	"fmt"
	"out/problematic"
	"testing"
)

func TestPost(t *testing.T) {
	config := problematic.NewConfiguration()
	config.BasePath = "http://localhost:8080"
	client := problematic.NewAPIClient(config)
	body := struct {
		Field string `json:"field"`
	}{
		"foo",
	}
	res, err := client.DefaultApi.PostJSON(nil, body)
	fmt.Println(res)
	fmt.Println(err)
}

Spin up a cute Flask server:

from flask import Flask, request

app = Flask(__name__)

@app.route('/', methods=['GET', 'POST'])
def root():
    content = request.json
    print content
    return "all right"

app.run(port=8080)

Running go test yielded:

$ go test
&{Status:200 OK StatusCode:200 Proto:HTTP/1.0 ProtoMajor:1 ProtoMinor:0 Header:map[Server:[Werkzeug/0.14.1 Python/2.7.12] Date:[Wed, 31 Jan 2018 12:56:29 GMT] Content-Type:[text/html; charset=utf-8] Content-Length:[9]] Body:0xc420128080 ContentLength:9 TransferEncoding:[] Close:true Uncompressed:false Trailer:map[] Request:0xc420112000 TLS:<nil>}
<nil>
PASS
ok      problematic-test        0.006s

Server logs:

 * Running on http://127.0.0.1:8080/ (Press CTRL+C to quit)
{u'field': u'foo'}
127.0.0.1 - - [31/Jan/2018 10:55:57] "POST / HTTP/1.1" 200 -

Seemengly there was no error. Did I do something wrong?

/cc @antihax @stephenrlouie @wing328

[wing328]

Instead of submitting a raw JSON, my suggestion is to clearly define the object in the OpenAPI spec so that the object can be deserialized into JSON properly. (this is not to say the spec in the original post is invalid)