Swagger OpenApi Spec 3.0-删除操作 [英] Swagger openApi Spec 3.0 - DELETE operation

查看:15
本文介绍了Swagger OpenApi Spec 3.0-删除操作的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我正在使用swagger Openapi规范3.0从我的界面生成swagger。我有一个Delete方法,它接受请求正文。但根据RFC7231Delete不接受任何请求Body。Swagger-request body也是如此。但是我的API被设计成在删除操作中接受请求正文。在创建swagger以使删除操作接受请求正文时有什么解决方法吗?目前,我从Savagger生成中得到的错误是什么?

Sematic error: DELETE operations cannot have a requestBody

推荐答案

否,不能使用OpenAPI3.0规范和swagger工具来实现带有请求Body的删除请求。正如您正确指出的,HTTPRFC说删除请求主体有no defined semantics(因此应该避免),OpenAPI 3.0明确禁止在主体没有定义语义的HTTP方法中存在主体。有关某些上下文,请参阅this discussion

考虑更改您的API设计,例如,用路径、查询字符串或Header参数替换删除Body。查看RESTful Alternatives to DELETE Request Body了解一些想法。

这篇关于Swagger OpenApi Spec 3.0-删除操作的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆