kayrah87/shortcut-api

访问 shortcut.com v3 API 的简单库

1.0.1 2022-04-28 08:25 UTC

This package is auto-updated.

Last update: 2024-09-28 13:46:10 UTC


README

访问 Shortcut.com V3 API 的库

安装

您可以使用 composer 安装此库

composer require kayrah87/shortcut-api

使用方法

要使用此库,您需要创建 ShortcutApi 类的新实例

$api = new kayrah87\Shortcut('YOUR_SHORTCUT_TOKEN');

然后,您可以使用它如下

获取

获取所选对象的所有列表

$api->get('object-name');

获取特定对象

$api->get('object-name', OBJECT_ID);

对象列表可以在 Shortcut.com API 文档 中找到。然而,您可能可以猜到大部分。

  • stories
  • epics
  • iterations
  • 等等

创建

创建新对象

$api->create('object-name', [
    // object fields
    ]);

同样,具体对象字段可以在 Shortcut.com API 文档 中找到。

更新

更新现有对象

$api->update('object-name', OBJECT_ID, [
    // object fields
    ]);

删除

删除现有对象

$api->delete('object-name', OBJECT_ID);

许可证

此库采用 MIT 许可证。有关更多信息,请参阅 LICENSE 文件。欢迎将此库用于您的项目或将其分支。谢谢!

贡献

此库是开源的。您可以在 Github 上提交拉取请求来贡献。

错误

请将任何错误或问题报告给 Github