小编API*_*lex的帖子

REST API 200 和 201 正文响应

问题\n我正在为我的公司编写 API 标准文档,并且一直在尝试各种工具来增强我们的 API 生命周期,今天我尝试了 apisecurity.io 的 API 定义安全验证工具,\ nit 突出显示了一个有趣的错误:我的 POST 操作:\n\xe2\x80\x9c您尚未为应包含正文的响应定义任何架构。\xe2\x80\x9d 链接:响应架构未定义并引用 RFC 7231

\n

标记的 API 端点是一个 POST 操作,该操作返回: 201 状态代码、 Location header 但没有 body。(因此会出现错误,因为该工具期望除 204 之外的所有 200 代码都有主体)

\n
\n

研究\ nRFC7231 第 6.3.2 节指出:

\n
\n

201(已创建)状态代码表示请求已\n得到满足,并导致\n创建一个或多个新资源。请求创建的主要资源由响应中的位置标头字段标识,或者如果未接收到位置字段,则由有效请求 URI 标识。

\n
\n
\n

201 响应负载通常描述并链接到所创建的资源。请参阅第 7.2 节,了解 201 响应中验证器标头字段(例如 ETag 和 Last-Modified)的含义和用途的讨论。

\n
\n

另外,当查看RFC7231 第 4.3.3 节为 POST 操作定义的内容时(当操作导致创建资源时),它指出:

\n
\n

如果作为成功处理 POST 请求的结果,在源服务器上创建了一个或多个资源,\n源服务器\n应该发送包含 Location …

api rest standards

6
推荐指数
1
解决办法
2万
查看次数

标签 统计

api ×1

rest ×1

standards ×1