API 使用说明文档

本服务提供一个简洁的 JSON API，允许您通过编程方式创建短网址。API 地址为：

POST http://127.0.0.1/api.php

1. 请求格式 (Request)

所有请求必须使用 POST 方法，并发送 JSON 格式的数据。请求头必须包含 Content-Type: application/json。

请求参数:

• url (string, 必填): 需要缩短的原始长网址 (Long URL)。必须包含 http:// 或 https://。
• custom_code (string, 可选): 自定义短码。如果该短码已被使用或格式不符，API 将返回错误。例如：提供 my-link 将生成 http://127.0.0.1/my-link。如果为空，系统将生成一个长度为 6 位的随机短码。
• password (string, 可选): 为短链接设置访问密码。如果设置，用户在访问短链接时需要输入此密码。

请求示例 (使用 cURL):

curl -X POST \
     -H "Content-Type: application/json" \
     -d '{
         "url": "https://www.google.com/search?q=very+long+query+example",
         "custom_code": "mycode123",
         "password": "securepassword"
     }' \
     http://127.0.0.1/api.php

2. 响应格式 (Response)

API 将以 JSON 格式返回响应，并使用标准的 HTTP 状态码来指示请求结果。

成功响应 (HTTP Status: 201 Created 或 200 OK):

当短网址成功创建 (201) 或检测到重复链接并返回已有链接 (200) 时，将返回以下格式：

{
    "message": "短网址创建成功",
    "long_url": "...",
    "short_code": "...",
    "short_url": "http://127.0.0.1/..."
}

错误响应 (HTTP Status: 400, 405, 409, 500 等):

当发生错误时，将返回相应的 HTTP 状态码和以下格式：

{
    "error": "错误描述，例如：请提供一个有效的长网址 (url)。"
}