README

需要一个像bit.ly、t.co、goo.gl一样易于使用的自定义URL缩短器？Shorten 是一个简单、符合PSR-7和PSR-15规范的轻量级无头URL缩短器，专为像您这样的开发者设计。

安装

Shorten 是一个小型微应用。它可以通过composer的 create-project 命令轻松安装。

composer create-project braid/shorten your-shortener-name

Shorten 附带两个示例配置文件。要配置您的实例，只需复制这些文件

cp config.example.php config.php
cp phinx.example.yml phinx.yml

根据需要编辑您新创建的 config.php 文件。

技巧：这里是一个快速生成API密钥的方法

php -r 'echo bin2hex(openssl_random_pseudo_bytes(32)) . "\n";'

Shorten 使用Rob Morgan的 Phinx 进行数据库迁移。Phinx有自己的配置，但值应与您的 config.php 中 database 设置相同。

一旦您的配置文件已创建并更新，请创建上面配置文件中指定的数据库。然后简单地运行迁移

vendor/bin/phinx migrate

最后一步是将HTTP服务器或虚拟主机指向 public 目录。本文档不会详细介绍如何设置Apache或nginx。

Shorten 提供了一个简单的API，用于创建、列出和删除缩短的URL。

所有API请求都必须包含一个格式为的 Authorization 标头

Authorization: Bearer api_secret_here

重定向资源的返回格式是JSON。示例

{
  "id": 1,
  "hash": "ce24227c",
  "redirect_to": "http://www.google.com",
  "count": 0,
  "url": "http://bit.ly/ce24227c"
}

注意：是的，DELETE /resources/{id} 可能更简洁，但使用简单的字符串可以更快地进行路由。

Shorten 旨在成为一个简单的设置并忘记的服务，您可以在组织内部使用或将其嵌入到您构建的应用程序中。请记住，它是一个项目而不是依赖项，因此您可以根据需要自由添加额外的 PSR-15 中间件。

Shorten 由 Braid LLC 编写和维护，并免费提供，遵循MIT许可证。