HATEOAS part shows direct object instead of the thing we get

Hi, currently I am using spring HATEOAS 1.0.1.RELEASE with spring-boot 2.2.1.RELEASE and springdoc-openapi-webmvc-core version 1.2.17. I saw that the project shows it support HATEOAS now but in swagger, I still see the example value show all the fields of EntityModel instead of the response we will get. Is there anything I need to config for that

Example value:

{
  "id": "string",
  "links": [
    {
      "rel": "string",
      "href": "string",
      "hreflang": "string",
      "media": "string",
      "title": "string",
      "type": "string",
      "deprecation": "string",
      "profile": "string",
      "name": "string"
    }
  ]
}

Response thing:

{
  "id": "test-id",
  "_links": {
    "self": {
      "href": "http://localhost:8374/my-path"
    }
  }
}

[mathieskristensen]

Hi,

As @kingtran2112 is pointing out, there is a mismatch between the generated documentation (based on EntityModel) and the actual JSON representations. If you are relying on the OpenAPI specification for customers and you are using Spring HATEOAS, this is not desirable.

I would expect links and embedded to follow the HAL specification draft (link), i.e. _links and _embedded. Furthermore, I would expect the structure within these sections to reflect the actual response representations rather than being based on the EntityModel structure.

[milindrao]

Thanks. I fixed it by doing the following.

Declare a CaseHrefRepresentation class

@SuppressWarnings("rawtypes")
@Schema (example = "{\"_links\": {\"self\": {\"href\": \"http://<domain:port>/cases/id/unique-key/case_id\"}}}")
class CaseHrefRepresentation extends RepresentationModel {}

In the method definition, use the class in the schema

@Operation(summary = "Creates and saves a case.",
           responses = { 
                @ApiResponse(responseCode = "201", description = "Created", content = @Content(schema = @Schema(implementation = CaseHrefRepresentation.class))),
                @ApiResponse(responseCode = "401", description = "Unauthorized", content = @Content),
})
@ResponseStatus(HttpStatus.CREATED)     // Needed to prevent the creation of HttpStatus.OK in swagger.
@PostMapping(value = "/cases",
             produces = {application/hal+json},
             consumes = {MediaType.APPLICATION_JSON_VALUE})
public ResponseEntity<RepresentationModel<?>> createCase(

I’m sure there’s a better more correct way to do this. But for now, it works for me.