Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Swagger documentation differing in structure from API response when using HAL

See original GitHub issue

Hi,

I am using Springfox 2.9.2.

I seem to still be experiencing a bug with HAL which is reported as fixed. The issue is described in #1980 and was reported fixed in #1927.

What I am seeing is that for a HAL enabled endpoint the swagger Documentation has a different structure to what is actually returned.

The swagger documentation describes this (I have simplified the model as we have a lot of fields):

{
  "_embedded": [
    {
      "_links": [
        {
          "deprecation": "string",
          "href": "string",
          "hreflang": "string",
          "media": "string",
          "rel": "string",
          "templated": true,
          "title": "string",
          "type": "string"
        }
      ],
      "name": "string",
      "key": "string",
      "referenceItemKey": "string"
    }
  ],
  "_links": [
    {
      "deprecation": "string",
      "href": "string",
      "hreflang": "string",
      "media": "string",
      "rel": "string",
      "templated": true,
      "title": "string",
      "type": "string"
    }
  ]
}

however the API returns this:

{
  "_embedded" : {
    "itemList" : [ {
      "name" : "Test Item 1",
      "key" : "ITEM_1",
      "referenceItemKey" : "ITEM_2",
      "_links" : {
        "self" : {
          "href" : "https://url.net/item-api/items/ITEM_1"
        },
        "referenceItem" : {
          "href" : "https://url.net/item-api/items/ITEM_2"
        }
      }
    }, {
      "name" : "Test Item 2",
      "key" : "ITEM_2",
      "_links" : {
        "self" : {
          "href" : "https://url.net/item-api/items/ITEM_2"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://url.net/item-api/items"
    }
  }
}

The main issue I am having is that in the swagger-doc the _embedded entry is an array, however in the return (and HAL specification) it is an object which contains a named object of type array.

Perhaps this is still a bug? Further note is that my API is returning only content type application/hal+json;charset=UTF-8