简单PHP短网址生成器技术文档

本文档将详细介绍如何安装、使用以及通过API接口操作简单PHP短网址生成器。

1. 安装指南

环境要求

确保您的服务器安装了PHP版本5.4.0或更高。

安装步骤

1. 从本仓库下载源代码，并将其上传到您的Web服务器。
2. 使用database.sql文件在您选择的数据库中创建redirect表。注意不要删除第10行的INSERT语句，因为它用于初始化数据库。
3. 编辑config.php文件并输入您的数据库凭证。
4. 为了增加安全性，可以考虑将shorten.php重命名为一个秘密的文件名，并相应地调整.htaccess文件（第3行）。

2. 项目使用说明

本项目具有以下特点：

• 当给定时数短码时，重定向到Twitter，例如：http://mths.be/8065633451249664 → http://twitter.com/mathias/status/8065633451249664。
• 使用@作为短码时，重定向到您的Twitter账户，例如：http://mths.be/@ → http://twitter.com/mathias。
• 使用+作为短码时，重定向到您的Google Plus账户，例如：http://mths.be/+ → https://plus.google.com/u/0/116553353277057965424/posts。
• 当没有短码时，重定向到您的主网站，例如：http://mths.be/ → http://mathiasbynens.be/。
• 当使用未知短码（数据库中不存在）时，重定向到您主网站上的特定页面，例如：http://mths.be/demo/jquery-size → http://mathiasbynens.be/demo/jquery-size。
• 忽略短码中的怪异尾部字符（!, ", #, $, %, &, ', (, ), *, +, ,, -, ., /, @, :, ;, <, =, >, [, \, ], ^, _, {, |, }, ~），这在短网址被糟糕的链接解析器处理时很有用，例如：http://mths.be/aaa) 与访问 http://mths.be/aaa 效果相同。
• 生成仅使用 [a-z] 字符的短、易输入的URL。
• 当尝试缩短相同的URL时，不会创建多个短URL。在这种情况下，脚本将仅返回该长URL的现有短URL。
• 代码简洁、最小化。
• 正确、符合语义地使用可用的HTTP状态码。
• 可以与Twitter for iPhone配合使用。只需进入设置 › 服务 › URL缩短 › 自定义… 并输入 http://yourshortener.ext/shorten?url=%@。

3. 项目API使用文档

本项目提供了一种简单的方式来通过API接口缩短URL。以下是两个可用的JavaScript书签代码：

提示版

javascript:(function(){const q=prompt('URL:');if(q){location='https://yourshortener.ext/shorten?url='+encodeURIComponent(q)}})();

短ening this URL

javascript:(function(){location='https://yourshortener.ext/shorten?url='+encodeURIComponent(location.href)})();

4. 项目安装方式

请按照上述“安装指南”中的步骤进行安装。

本项目遵循MIT许可证。如需更多信息，请查阅项目LICENSE文件。

作者：Mathias Bynens (个人网站)

贡献者：Peter Beverloo (个人网站)、Tomislav Biscan (GitHub)