README

这是一个生成和恢复短链接的库。

需求

PHP >= 8.0.0
Laravel >= 9.0.0

功能

生成短链接
恢复短链接
从屏幕生成短链接（可选开关）
使用 API 生成短链接（可选开关）
使用 API 恢复短链接（可选开关）
屏幕/API 生成短链接时需要密码验证的功能（可选开关）
短链接预览功能（可选开关）
屏幕/API 端点更改功能
更改短链接中随机字符的数量
更改短链接中使用的字符类型

快速开始

启动控制台，移动到您想要安装的文件夹。
安装 Laravel。

composer create-project "laravel/laravel" .

安装 Url Shorter。

composer require hirossyi73/url-shorter

打开 ".env" 文件，输入数据库信息。

DB_CONNECTION=mysql
DB_HOST=(Host Name)
DB_PORT=(Port Name)
DB_DATABASE=(Database Name)
DB_USERNAME=(User Name)
DB_PASSWORD=(Password)

# To enable the shortened URL function from the screen
URL_SHORTER_ENABLED_WEB_MAKE=true

输入以下命令。

php artisan vendor:publish --provider="Hirossyi73\UrlShorter\UrlShorterServiceProvider"
php artisan migrate

启动服务器。

php artisan serve

尝试

通过访问以下 URL，将跳转到短链接生成屏幕。
http(s)://(URL)/make
输入 URL 并点击“转换”按钮。

您可以通过在浏览器中粘贴生成的 URL 来重定向到原始 URL。

密码验证

可以在短链接生成屏幕上设置密码验证。

打开 ".env" 文件并输入以下信息。

URL_SHORTER_AUTH_USE=true
URL_SHORTER_AUTH_PASSWORD=(Password)

现在，当您访问短链接生成屏幕时，将提示密码验证。

预览

当您在浏览器中输入短链接时，可以显示预览屏幕而无需直接跳转。
打开 ".env" 文件并输入以下信息。

URL_SHORTER_USE_PREVIEW=true

如果您在浏览器中输入短链接，将提示预览。

API

您可以使用 API。

打开 ".env" 文件并输入以下信息。

URL_SHORTER_ENABLED_API=true #When using original URL recovery from shortened URL
URL_SHORTER_ENABLED_API_MAKE=true #When using shortened URL generation

您现在可以使用短链接 API。

生成短链接

http(s)://(URL)/api/make POST
Content-Type : application/json

POST VALUE:
{
  "url": "(URL to shorten)"
}

RETURN VALUE:
{
  "url": "(URL to shorten)",
  "key": "(Key)",
  "updated_at": "(Updated Datetime)",
  "created_at": "(Created Datetime)",
  "generate_url": "(Generate URL)"
}

从短链接恢复

http(s)://(URL)/api/g POST
Content-Type : application/json

POST VALUE:
{
  "generate_url": "(Shortened URL)"
}

RETURN VALUE:
{
  "url": "(URL to shorten)",
  "key": "(Key)",
  "updated_at": "(Updated Datetime)",
  "created_at": "(Created Datetime)",
  "generate_url": "(Generate URL)"
}

设置值

添加到 ".env" 文件。

URL_SHORTER_USE_PREVIEW

使用预览功能时，设置 true（默认：false）

URL_SHORTER_AUTH_USE

执行短链接生成功能时的密码验证，设置 true（默认：false）

URL_SHORTER_AUTH_PASSWORD

密码验证的密码字符串

URL_SHORTER_GENERATE_WORDS

生成短链接时使用的字符字符串

URL_SHORTER_GENERATE_LENGTH

生成短链接时使用的字符数

URL_SHORTER_GENERATE_CHECK_ALREADY_EXISTS

当为 true 时，创建短密钥后检查是否存在（默认：true）

URL_SHORTER_ENABLED_WEB

如果为 true，则访问短链接时使用重定向页面（默认：true）

URL_SHORTER_ENABLED_WEB_MAKE

如果为 true，则使用短链接生成页面（默认：false）

URL_SHORTER_ENABLED_API

如果为 true，则使用 API 从短链接获取原始 URL（默认：false）

URL_SHORTER_ENABLED_API_MAKE

如果为 true，则使用短链接生成 API（默认：false）

hirossyi73 / url-shorter

维护者

详细信息