locomotivemtl/o6c-api

此软件包最新版本（dev-master）没有提供许可证信息。

维护者

详细信息

github.com/locomotivemtl/o6c-api

源代码

问题

安装: 0

依赖: 0

建议: 0

安全: 0

星标: 1

关注者: 12

分支: 0

开放问题: 0

dev-master 2020-05-01 16:46 UTC

Requires

Requires (Dev)

Unknown License 7b12f4ff4c5d24ede726fb98e66bb5c51f22e119

  • Mathieu Ducharme <mat.woop@locomotive.ca>

This package is auto-updated.

Last update: 2024-08-29 05:32:35 UTC

README

仅6个字符。基于Slim 4（PSR-7和PSR-15）的URL缩短器。

composer create-project locomotivemtl/o6c-api

API

保持简单。

  • GET /{code}
    • 重定向到原始URL。
  • POST /api/v1/login
    • 从凭证中检索一个认证令牌（jwt）。
  • POST /api/v1/shorten
    • 创建一个新的短链接。必须提供一个有效的访问令牌。

请参阅 locomotivemtl/o6c-client，以了解如何与该API交互的简单客户端库。

依赖项

  • PHP 7.2+
  • Slim 4
  • pimple/pimple
  • lcobucci/jwt

如何安装

  • composer install
  • 设置MySQL/MariaDB数据库。
    • 导入 data/schema.sql。
  • 将 config/config.sample.php 复制到 config/config.php 并编辑其值以适应您的环境。
  • 生成JWT令牌的RSA密钥 cd config;sh jwt.sh。
  • 设置您的Web服务器（带短URL！），指向 public/。
    • 在开发环境中，尝试 composer start。

添加新用户

工作中。

在 users 表中手动添加它们。密码格式为

$password = password_hash($plain, PASSWORD_DEFAULT);