在安企CMS的日常运营和开发中，我们经常需要通过API接口来获取网站的内容，其中“获取文档详情接口”（/api/archive/detail）无疑是使用频率最高的之一。这个接口允许我们通过文档ID或URL别名（filename）来获取特定文章或产品的详细信息。然而，在使用过程中，我们难免会遇到这样的情况：当请求的文档在系统中并不存在时，接口会返回怎样的错误提示呢？这对于前端页面展示、后端逻辑判断以及错误日志记录都至关重要。

首先，让我们回顾一下“获取文档详情”接口的基本工作方式。当一个文档（例如一篇文章、一个产品页面）通过其唯一的ID或自定义的URL别名（filename）被请求时，如果该文档确实存在于安企CMS中，接口通常会返回一个成功的响应。这意味着响应的code字段为0，msg字段为空，而data字段则会包含文档的所有详细数据，如标题、内容、SEO信息等。

那么，当请求的文档ID或filename指向了一个不存在的文档时，接口会如何响应呢？根据安企CMS API的设计规范，这种情况下接口会返回一个明确的错误提示。具体来说，响应结构会是这样的：

{
  "code": -1,
  "msg": "文档不存在",
  "data": null
}

从这个返回示例中，我们可以清晰地看到几个关键点：

  1. code 字段变为 -1：这表示一个通用的业务逻辑错误。在安企CMS的错误代码体系中，0通常代表成功，而-1则指示了发生了某种错误，具体原因需要结合msg字段来判断。
  2. msg 字段会提供具体的错误原因：在本例中，msg会明确显示“文档不存在”。这是一个非常友好的提示，它直接告诉我们请求的内容未能找到。实际中，根据CMS的配置或版本，这个信息可能会有细微差别，但核心含义都是指明资源缺失。
  3. data 字段为 null：由于文档本身不存在，自然也无法返回任何文档详情数据，因此data字段会是一个空值（null）。这与获取“下一个文档”或“上一个文档”接口在没有对应文档时返回data: null的逻辑是一致的，保持了API返回结果的一贯性。

理解这一错误提示机制对于开发者和网站运营者都非常重要。在前端，我们可以根据code为-1和msg为“文档不存在”的情况，向用户展示一个友好的“404页面”或“内容未找到”的提示，而不是一个生硬的系统错误。在后端处理中，我们可以利用这些信息来记录日志，分析无效请求，或者触发其他业务逻辑，例如跳转到相关内容列表页。

常见问题解答（FAQ）

Q1: 如果我在请求“获取文档详情”接口时，既没有提供id也没有提供filename，会返回怎样的错误？ A1: 如果请求参数中既没有id也没有filename，这属于请求参数不完整或不符合规范的错误。接口通常会返回code: -1，并在msg中指出是参数缺失或参数无效的错误，例如“参数错误”或者“缺少必要的参数”。这种错误与“文档不存在”是不同层面的问题。

Q2: 除了code: -1，文档中还提到了1001、1002等错误码，它们与“文档不存在”有什么区别？ A2: code: -1通常表示业务逻辑层面的错误，比如“文档不存在”就是一种业务逻辑错误。而像1001（未登录）、1002（未授权）则属于权限验证层面的错误。这意味着即使文档可能存在，但如果用户没有相应的权限访问，也会返回这些权限相关的错误码。200虽然也被列为错误码，但它在HTTP状态码中通常表示成功，在安企CMS的API设计中，code: 0才是业务上的成功标志。

Q3: “文档不存在”的msg内容“文档不存在”可以自定义为其他更个性化的文字吗？ A3: 接口返回的msg字段内容通常是由安企CMS后端程序预设的系统消息。如果需要自定义这些提示信息，通常需要修改安企CMS的后端代码或者通过CMS提供的国际化（i18n）或语言包管理功能来实现。在纯粹的API调用层面，我们无法直接修改msg字段的文本内容。