如何使用swagger open API 3.0的springdoc生成Map〈String，Object>类型的请求体？

qnakjoqk 于 2023-02-04 发布在 Spring

关注(0)|答案(2)|浏览(316)

对于下面的代码，只生成了参数id，它完全缺少“请求正文”部分。
我在https://swagger.io/docs/specification/data-models/dictionaries/的基础上添加了type="object"。

public Item addProperties(
    @Parameter(description = "identifier of the item")
        @PathVariable("id") String id,
    @Parameter(
        description = "map of property names and values ", 
        content = @Content(
            schema = @Schema(
                type = "object",
                implementation = Map.class)))
        @RequestBody Map<String, Object> properties)

spring-boot

来源：https://stackoverflow.com/questions/60087929/how-to-generate-requestbody-of-type-mapstring-object-using-springdoc-for-swag

2条答案

按热度按时间

2hh7jdfx1#

@RequestBody类型必须是一个类。所以Map的任何实现都可以工作（iIndieeHashMap）。

@RequestBody HashMap<String, Object> properties

赞(0）回复(0）举报 2023-02-04

y1aodyip2#

Map类型似乎被Open API忽略了（* 尽管我没有关于此声明的可靠引用 *）。
参考：GitHub ~ Issues ~ #597 ~ Request Body for Maps not available in Swagger-UI
下面是上面GitHub问题中描述的解决方案。

static {
    SpringDocUtils.getConfig().removeRequestWrapperToIgnore(java.util.Map.class);
}

将静态块放入@SpringBootApplication类中，这样就可以解决问题。

@RequestBody Map<String, Object> properties // Should now generate correctly

另见

赞(0）回复(0）举报 2023-02-04

我来回答

如何使用swagger open API 3.0的springdoc生成Map〈String，Object>类型的请求体？

2条答案

另见

相关问题

热门标签

最新问答