文章密码验证接口文档

接口概述

该接口用于验证文章的访问密码是否正确，在访问加密文章前进行密码验证。无需登录即可访问。

接口信息

  • 接口URL: /api/articles/password-verify
  • 请求方法: POST
  • 权限要求: 无需登录即可访问

请求参数

参数名 类型 必填 说明 示例值
id number 是 文章ID 1
password string 是 文章访问密码 "123456"

响应结构

typescript 复制代码 
interface Response {
  code: number;      // 状态码
  message: string;   // 响应消息
  data: null;        // 无返回数据
}

响应示例

验证成功

json 复制代码 
{
  "code": 0,
  "message": "密码正确",
  "data": null
}

验证失败

json 复制代码 
{
  "code": 401,
  "message": "密码错误",
  "data": null
}

特殊说明

  • 在访问加密文章前调用此接口验证密码。
  • 验证通过后，可使用相同密码调用文章详情接口。
  • 此接口仅验证密码，不返回文章信息。

错误码说明

错误码 说明 处理建议
0 成功 密码正确，可以访问文章
400 参数错误 检查ID和密码是否都已提供
401 密码错误 检查密码是否正确
404 文章不存在 检查文章ID是否正确

调用示例

typescript 复制代码 
const response = await fetch('/api/articles/password-verify', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    id: 1,
    password: "123456"
  })
});

const result = await response.json();
if (result.code === 0) {
  // 密码正确，可以访问文章
  console.log('密码验证通过');
} else {
  // 密码错误或其他错误
  console.error(result.message);
}