README

此包是为 Laravel 定制的

Backlog 的 PHP 库。

• Backlog
• Backlog API 版本 2
  • https://developer.nulab-inc.com/ja/docs/backlog/

源代码

原始来源

https://github.com/itigoppo/backlog-api

要求

• PHP ^7.2.5 || ^8.0

内容

• 安装

安装

composer require phuongnamdang/laravel-backlog-api

使用

设置 .env

BACKLOG_SPACE=公司名称 BACKLOG_SECRET=apisecretkey BACKLOG_DOMAIN=jp or com

示例

namespace App\Http\Controllers;

use Itigoppo\BacklogApi\Backlog\Backlog;

class BacklogController extends Controller
{
    public function index(Backlog $backlog) {
        dump(app('backlog')->users->myself());
        dump(\BacklogApi::statuses());
        dump($backlog->users->myself());
        dd($backlog->projects->load());
    }
}

对于较旧的 Laravel 版本

请更新 app.php 以设置提供者和别名

'providers' => [
    Itigoppo\BacklogApi\Providers\LaravelServiceProvider::class,
],
'aliases' => [
    'BacklogApi' => Itigoppo\BacklogApi\Facades\Backlog::class,
]

以下为原始文档

请根据您使用的空间更改 $domain 部分。默认为「jp」。

获取状态列表

$backlog->statuses();

获取完成原因列表

$backlog->resolutions();

获取优先级列表

$backlog->priorities();

添加星标

$backlog->addStar([array $form_options = []]);

请参考以下请求参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/add-star/

空间

获取空间信息

$backlog->space->info();

获取最近的更新

$backlog->space->notification();

获取空间通知

$backlog->space->activities();

更新空间通知

$backlog->space->putNotification(string $content_body);

获取空间容量使用情况

$backlog->space->diskUsage();

发送附件

$multipart = [
    [
        'name' => 'file',
        'contents' => fopen('test.txt', 'r'),
        'filename' => 'file name',
        'headers' => [
            'Content-Type' => 'application/octet-stream'
        ]
    ]
];
$backlog->space->postAttachment(array $multipart);

以下尚未实现

• GET /api/v2/space/image
• GET /api/v2/space/attachment

用户

获取用户列表

$backlog->users->load();

获取用户信息

$backlog->users->find(int $user_id);

添加用户

$backlog->users->create(int $user_id, string $password, string $name, string $mail_address, int $role_type);

请参考以下查询参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/add-user/

获取认证用户信息

$backlog->users->myself();

获取用户的最近活动

$backlog->users->activities(int $user_id[, array $query_params = []]);

请参考以下查询参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-user-recent-updates/

获取用户收到的星标列表

$backlog->users->stars(int $user_id[, array $query_params = []]);

请参考以下查询参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-received-star-list/

获取用户收到的星标数量

$backlog->users->numberOfStars(int $user_id[, array $query_params = []]);

请参考以下查询参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/count-user-received-stars/

获取自己最近查看的议题列表

$backlog->users->recentlyViewedIssues([array $query_params = []]);

请参考以下查询参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-list-of-recently-viewed-issues/

获取自己最近查看的项目列表

$backlog->users->recentlyViewedProjects([array $query_params = []]);

请参考以下查询参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-list-of-recently-viewed-projects/

获取自己最近查看的 Wiki 列表

$backlog->users->recentlyViewedWikis([array $query_params = []]);

请参考以下查询参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-list-of-recently-viewed-wikis/

以下尚未实现

• PATCH /api/v2/users/:userId
• DELETE /api/v2/users/:userId
• GET /api/v2/users/:userId/icon

组

获取组列表

$backlog->groups->load([array $query_params = []]);

请参考以下查询参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-list-of-groups/

获取组信息

$backlog->groups->find(int $group_id);

以下尚未实现

• POST /api/v2/groups
• PATCH /api/v2/groups/:groupId
• DELETE /api/v2/groups/:groupId

项目

获取项目列表

$backlog->projects->load([array $query_params = []]);

请参考以下查询参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-project-list/

获取项目状态列表

$backlog->projects->statuses(string $project_id_or_key);

获取项目信息

$backlog->projects->find(string $project_id_or_key);

获取项目的最近活动

$backlog->projects->activities(string $project_id_or_key[, array $query_params = []]);

请参考以下查询参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-project-recent-updates/

获取项目用户列表

$backlog->projects->users(string $project_id_or_key);

获取项目管理员列表

$backlog->projects->administrators(string $project_id_or_key);

获取种类列表

$backlog->projects->issueTypes(string $project_id_or_key);

添加种类

$backlog->projects->createIssueType(string $project_id_or_key, string $name, string $color);

更新种类信息

$backlog->projects->updateIssueType(string $project_id_or_key, int $issue_type_id[, array $form_options = []]);

请参考以下请求参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/update-issue-type/

删除种类

$backlog->projects->deleteIssueType(string $project_id_or_key, int $issue_type_id, int $substitute_issue_type_id);

获取类别列表

$backlog->projects->categories(string $project_id_or_key);

添加类别

$backlog->projects->createCategory(string $project_id_or_key, string $name);

更新类别信息

$backlog->projects->updateCategory(string $project_id_or_key, int $category_id[, array $form_options = []]);

请参考以下请求参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/update-category/

删除类别

$backlog->projects->deleteCategory(string $project_id_or_key, int $category_id);

获取版本（里程碑）列表

$backlog->projects->versions(string $project_id_or_key);

添加版本（里程碑）

$backlog->projects->createVersion(string $project_id_or_key, string $name[, array $form_options = []]);

请参考以下请求参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/add-version-milestone/

更新版本（里程碑）信息

$backlog->projects->updateVersion(string $project_id_or_key, int $version_id, string $name[, array $form_options = []]);

请参考以下请求参数 https://developer.nulab-inc.com/ja/docs/backlog/api/2/update-version-milestone/

删除版本（里程碑）

$backlog->projects->deleteVersion(string $project_id_or_key, int $version_id);

获取项目的容量使用情况

$backlog->projects->diskUsage(string $project_id_or_key);

以下尚未实现

• POST /api/v2/projects
• POST /api/v2/projects/:projectIdOrKey
• DELETE /api/v2/projects/:projectIdOrKey
• GET /api/v2/projects/:projectIdOrKey/image
• POST /api/v2/projects/:projectIdOrKey/users
• DELETE /api/v2/projects/:projectIdOrKey/users
• POST /api/v2/projects/:projectIdOrKey/administrators
• DELETE /api/v2/projects/:projectIdOrKey/administrators
• GET /api/v2/projects/:projectIdOrKey/customFields
• POST /api/v2/projects/:projectIdOrKey/customFields
• PATCH /api/v2/projects/:projectIdOrKey/customFields/:id
• DELETE /api/v2/projects/:projectIdOrKey/customFields/:id
• POST /api/v2/projects/:projectIdOrKey/customFields/:id/items
• PATCH /api/v2/projects/:projectIdOrKey/customFields/:id/items/:itemId
• DELETE /api/v2/projects/:projectIdOrKey/customFields/:id/items/:itemId
• GET /api/v2/projects/:projectIdOrKey/files/metadata/:path
• GET /api/v2/projects/:projectIdOrKey/files/:sharedFileId
• GET /api/v2/projects/:projectIdOrKey/webhooks
• POST /api/v2/projects/:projectIdOrKey/webhooks
• GET /api/v2/projects/:projectIdOrKey/webhooks/:webhookId
• PATCH /api/v2/projects/:projectIdOrKey/webhooks/:webhookId
• DELETE /api/v2/projects/:projectIdOrKey/webhooks/:webhookId

问题

获取任务列表

$backlog->issues->load([array $query_options = []]);

查询参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-issue-list/

获取任务数量

$backlog->issues->count([array $query_options = []]);

查询参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/count-issue/

添加任务

$backlog->issues->create(int $project_id, string $summary, int $issue_type_id, int $priority_id[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/add-issue/

获取任务信息

$backlog->issues->find(string $issues_id_or_key);

更新任务信息

$backlog->issues->update(string $issues_id_or_key[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/update-issue/

删除任务

$backlog->issues->delete(string $issues_id_or_key);

获取任务评论

$backlog->issues->comments(string $issues_id_or_key[, array $query_options = []]);

查询参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-comment-list/

添加任务评论

$backlog->issues->createComment(string $issues_id_or_key, string $content[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/add-comment/

获取任务评论数量

$backlog->issues->numberOfComments(string $issues_id_or_key);

获取任务评论信息

$backlog->issues->findComment(string $issues_id_or_key, int $comment_id);

更新任务评论信息

$backlog->issues->updateComment(string $issues_id_or_key, int $comment_id[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/update-comment/

获取任务评论通知列表

$backlog->issues->commentNotifications(string $issues_id_or_key, int $comment_id);

添加任务评论通知

$backlog->issues->createCommentNotification(string $issues_id_or_key, int $comment_id[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/add-comment-notification/

获取任务附件列表

$backlog->issues->attachments(string $issues_id_or_key);

下载任务附件

$backlog->issues->attachment(string $issues_id_or_key, string $attachment_id);

获取任务共享文件列表

$backlog->issues->sharedFiles(string $issues_id_or_key);

以下尚未实现

• DELETE /api/v2/issues/:issueIdOrKey/attachments/:attachmentId
• POST /api/v2/issues/:issueIdOrKey/sharedFiles
• DELETE /api/v2/issues/:issueIdOrKey/sharedFiles/:id

维基

获取维基页面列表

$backlog->wikis->load(string $project_id_or_key);

获取维基页面数量

$backlog->wikis->count($project_id_or_key);

获取维基页面标签列表

$backlog->wikis->tags($project_id_or_key);

添加维基页面

$backlog->wikis->create(int $project_id, string $name, string $content[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/add-wiki-page/

获取维基页面信息

$backlog->wikis->find(int $wiki_id);

更新维基页面信息

$backlog->wikis->update(int wiki_id[, array $form_options = []);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/update-wiki-page/

删除维基页面

$backlog->wikis->delete(int $wiki_id);

获取维基附件列表

$backlog->wikis->attachments(int $wiki_id);

获取维基页面更新历史列表

$backlog->wikis->history(int $wiki_id[, array $query_options = []]);

查询参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-wiki-page-history/

获取维基页面星标列表

$backlog->wikis->stars(int $wiki_id);

以下尚未实现

• POST /api/v2/wikis/:wikiId/attachments
• GET /api/v2/wikis/:wikiId/attachments/:attachmentId
• DELETE /api/v2/wikis/:wikiId/attachments/:attachmentId
• GET /api/v2/wikis/:wikiId/sharedFiles
• POST /api/v2/issues/:issueIdOrKey/sharedFiles
• DELETE /api/v2/wikis/:wikiId/sharedFiles/:id

通知

获取通知列表

$backlog->notifications->load([array $query_options = []]);

查询参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-notification/

获取通知数量

$backlog->notifications->count([array $query_options = []]);

查询参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/count-notification/

重置通知数量

$backlog->notifications->markAllAsRead();

标记通知为已读

$backlog->notifications->markAsRead(int $notification_id);

Git

获取Git仓库列表

$backlog->git->repositories(string $project_id_or_key);

获取Git仓库

$backlog->git->findRepositories(string $project_id_or_key, string $repository_id_or_name);

获取拉取请求列表

$backlog->git->pullRequests(string $project_id_or_key, string $repository_id_or_name[, array $query_options = []]);

查询参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-pull-request-list/

获取拉取请求数量

$backlog->git->numberOfPullRequests(string $project_id_or_key, string $repository_id_or_name[, array $query_options = []]);

查询参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-number-of-pull-requests/

添加拉取请求

$backlog->git->createPullRequests(string $project_id_or_key, string $repository_id_or_name, string $summary, string $description, string $base_branch, string $merge_branch[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/add-pull-request/

获取拉取请求

$backlog->git->findPullRequest(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number);

更新拉取请求

$backlog->git->updatePullRequest(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/update-pull-request/

获取拉取请求评论

$backlog->git->pullRequestComments(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number[, array $query_options = []]);

查询参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-pull-request-comment/

添加拉取请求评论

$backlog->git->createPullRequestComment(string $project_id_or_key, string $repository_id_or_name,  int $pull_request_number, string $content[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/add-pull-request-comment/

获取拉取请求评论数量

$backlog->git->numberOfPullRequestComments(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number);

更新拉取请求评论信息

$backlog->git->updatePullRequestComment(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number, int $comment_id[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/update-pull-request-comment-information/

获取拉取请求附件列表

$backlog->git->pullRequestAttachments(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number);

以下尚未实现

• GET /api/v2/projects/:projectIdOrKey/git/repositories/:repoIdOrName/pullRequests/:number/attachments/:attachmentId
• DELETE /api/v2/projects/:projectIdOrKey/git/repositories/:repoIdOrName/pullRequests/:number/attachments/:attachmentId

关注

获取关注列表

$backlog->watchings->load(int $user_id[, array $query_options = []]);

查询参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-watching-list/

获取关注数量

$backlog->watchings->count(int $user_id[, array $query_options = []]);

查询参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/count-watching/

获取关注信息

$backlog->watchings->find(int $watching_id);

添加关注

$backlog->watchings->create(string $issues_id_or_key[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/add-watching/

更新关注

$backlog->watchings->update(int $watching_id[, array $form_options = []]);

请求参数请参考以下链接 https://developer.nulab-inc.com/ja/docs/backlog/api/2/update-watching/

删除关注

$backlog->watchings->delete(int $watching_id);

标记关注为已读

$backlog->watchings->markAsRead(int $watching_id);

许可证

MIT许可证（MIT）。