REST API未实现操作的HTTP状态码选择及OpenAPI展示疑问

状态码：选501而非405 #

• 405 Method Not Allowed的适用场景是：请求的HTTP方法在当前资源上完全不被允许（比如规范里就没定义这个方法）。比如某个接口只设计了GET请求，用户硬发POST，这时候返回405，同时要在Allow响应头里列出该资源支持的所有方法。
• 501 Not Implemented才是对应「规范里已定义该操作，但当前服务器还没完成实现」的场景。它能清晰传递「这个功能是规划内的，但现在还做不了」的信息，完全匹配你的情况。

OpenAPI规范的响应配置 #

• 必须在规范里为该操作添加501响应的定义。这样调用方在查阅规范时就能提前知晓：这个操作目前处于未实现状态，调用后会收到501响应。
• 规范里要保留该操作的完整定义（毕竟这是你的目标实现），同时在501响应的描述里明确说明「该操作暂未实现，后续版本将提供支持」。

内容的提问来源于stack exchange，提问作者nik0x1