Better Support for 2 dimensional arrays

[amitbansal012]

Hi team,
I am using io.springfox:springfox-swagger2:2.1.1 jar to generate swagger specs. I am having issues with 2D arrays and nested maps.

The generated swagger spec looks like:

{
    "basePath": "/",
    "definitions": {
        "Map«string,string»": {
            "additionalProperties": {
                "type": "string"
            },
            "type": "object"
        }
    },
    "host": "hostname:port",
    "info": {
        "contact": {
            "name": "springfox"
        },
        "description": "This is a Sample service just to see how springfox works",
        "license": {
            "name": "Apache License Version 2.0",
            "url": "https://github.com/springfox/springfox/blob/master/LICENSE"
        },
        "termsOfService": "http://springfox.io",
        "title": "MySampleService :) ",
        "version": "2.0"
    },
    "paths": {
        "/service/testService/getInnerMap": {
            "get": {
                "consumes": [
                    "application/json"
                ],
                "operationId": "getInnerMapUsingGET",
                "produces": [
                    "*/*"
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "additionalProperties": {
                                "$ref": "#/definitions/Map«string,string»"
                            },
                            "type": "object"
                        }
                    },
                    "401": {
                        "description": "Unauthorized"
                    },
                    "403": {
                        "description": "Forbidden"
                    },
                    "404": {
                        "description": "Not Found"
                    }
                },
                "summary": "This is test service",
                "tags": [
                    "test"
                ]
            }
        },
        "/service/testService/getPrimitiveDouble3": {
            "get": {
                "consumes": [
                    "application/json"
                ],
                "operationId": "getPrimitiveDouble3UsingGET",
                "produces": [
                    "*/*"
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "items": {
                                "$ref": "#/definitions/Array"
                            },
                            "type": "array"
                        }
                    },
                    "401": {
                        "description": "Unauthorized"
                    },
                    "403": {
                        "description": "Forbidden"
                    },
                    "404": {
                        "description": "Not Found"
                    }
                },
                "summary": "This is test service - getPrimitiveDouble3",
                "tags": [
                    "test"
                ]
            }
        }
    },
    "swagger": "2.0",
    "tags": [
        {
            "name": "test",
            "description": "Operations in test service"
        }
    ]
}

Issue with 2D arrays

My java method looks like :
Interface:
int[][] getPrimitiveDouble3();

Impl:

@Override
@ApiOperation(value = "This is test service - getPrimitiveDouble3")
@RequestMapping(value = "/getPrimitiveDouble3", method = GET)
@ResponseBody
public int[][] getPrimitiveDouble3() {
return null;
}

I confirmed with Swagger team, looks like this is not the correct spec for 2D arrays [https://github.com/swagger-api/swagger-codegen/issues/1202]. Please let me know if this a bug.

Generated Spec [Incorrect]

 "schema": {
              "type": "array",
              "items": {
                  "$ref": "#/definitions/Array"
                }
              }

Expected Spec [Correct]

  "schema": {
              "type": "array",
              "items": {
                "type": "array",
                "items": {
                  "$ref": "#/definitions/Pet"
                }
              }
          }

Issue with nested maps

My java method looks like :
Interface:
Map<String, Map<String, String>> getInnerMap();

Impl:

    @Override 
    @ApiOperation(value = "This is test service")
    @RequestMapping(value = "/getInnerMap", method = GET)
    @ResponseBody
    public Map<String, Map<String, String>> getInnerMap() {
          return null;
    }

I confirmed with Swagger team, looks like this is not the correct spec for nested maps. Please let me know if this a bug.

Thanks,
Amit Bansal

[dilipkrish]

Thanks for reporting this is definitely a bug

[amitbansal012]

Hi Dilip,
Thank you for responding. Can you please let me know if the bug is with both 2D arrays and nested Maps?

Thanks,
Amit Bansal

[dilipkrish]

@amitbansal012 Not sure what the issue is with Maps. It appears to work fine in 2.3.0. The nested arrays is definitely not supported.