一个 java 方法返回一个 java.util.Map 在 openapi 中生成一个字符串返回，而不是一个 Z46BZ1EA056CAABEEA23F

Question

我从 Java REST 服务中生成OpenAPI json，在 ZA2F2ED4F8EBC2CBB4C21A29 它的方法返回java.util.Map 。

@Operation(description = "Retourne les communes du Code Officiel Geographique en vigueur une année particulière.")
@RequestMapping(value = "/communes", method=RequestMethod.GET)
@ApiResponses(value = {
     @ApiResponse(responseCode = "200", description = "Communes présentes sur le territoire cette année là, sous la forme d'une Map<String, Commune>.",
           content = {@Content(schema = @Schema(implementation = Map.class))}
     ),
     @ApiResponse(responseCode = "500", description = "Un incident est survenu durant l'extraction des communes.")
   }
)   
public Map<String, Commune> obtenirCommunes(
   @Parameter(name = "anneeCOG", description = "Année du Code Officiel Géographique.", example = "2019")
   @RequestParam(name="anneeCOG") int anneeCOG) throws TechniqueException {
   CodeOfficielGeographique cog = this.cogService.obtenirCodeOfficielGeographique(this.session, anneeCOG);

   return cog.getCommunesAsMap();
}

但是生成的 json 没有描述 Map 用于我的方法的返回类型：

"/cog/communes":{
"get":{"tags":["cog-controller"],
"description":"Retourne les communes du Code Officiel Geographique en vigueur une année particulière.",
"operationId":"obtenirCommunes", "parameters":
[{"name":"anneeCOG","in":"query",
"description":"Année du Code Officiel Géographique.",
"required":true,"schema":{"type":"integer","format":"int32"},"example":2019}],
"responses":{"500":{"description":"Un incident est survenu durant l'extraction des communes.",
"content":{"*/*":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Commune"}}}}},
"200":{"description":"Communes présentes sur le territoire cette année là, sous la forme d'une Map<String, Commune>.",
"content":{"*/*":{"schema":{"type":"string"}}}}}}}

相反，它返回一个"schema":{"type":"string"} 。

我做错了什么？

• 是content = {@Content(schema = @Schema(implementation = Map.class))}我和responseCode = "200"一起放错了吗？

• 我缺少注释吗？

Answer 1

这个注释是我麻烦的原因。

@ApiResponse(responseCode = "200", description = "Communes présentes sur le territoire cette année là, sous la forme d'une Map<String, Commune>.",
  content = {@Content(schema = @Schema(implementation = Map.class))}
),

内容：

content = {@Content(schema = @Schema(implementation = Map.class))}

必须删除。