hametuha/backilog-scraper

用于backlog API的PHP库

1.0.0 2016-02-11 16:28 UTC

This package is auto-updated.

Last update: 2024-09-09 18:46:23 UTC


README

通过Backlog API抓取Backlog的爬虫。

如何使用

首先,这个库需要composer

composer install

在PHP文件中

// Include auto loader.
require 'vendor/autoload.php';
// Initialize with local JSON file.
$request = new Hametuha\Backlog\Request( './config.json' );
// Get all milestones
$response = $request->get( "/api/v2/projects/MYPROJECT/versions" );
// Do something.
foreach( $response as $milestone ){
   // Do stuff.
}

您可以在Packagist找到这个库。在您的composer.json中,写入以下内容。

"require": {
    "hametuha/backlog-scraper": "1.*",
}

参考

Hametuha\Backlog\Request类有以下方法。

__constructor

@params string|array $config JSON文件路径或数组。必需参数是apiKeybase。您可以像这样获取API密钥(链接)base代表您backlog的URL。通常,它将是像https://your-account.backlog.jp这样的。示例JSON将是

{
  "apiKey": "yourapikeyitslenghtwillbeverylong",
  "base": "https://your-account.backlog.jp"
}

get

向Backlog发送GET请求。

@params string $endpoint 端点URL,例如/api/v2/projects/project-name/version。您可以在nulab开发者中找到它。

@params array $params 请求参数。在GET请求中,它将转换为查询参数。

post

get相同,但它发送POST请求。

put

get相同,但它发送PUT请求。

patch

get相同,但它发送PATCH请求。

delete

get相同,但它发送DELETE请求。

变更日志

  • 1.0.0 首次发布。

许可证

MIT许可证(MIT)版权所有(c)2016 Hametuha INC。

特此授予任何获得此软件及其相关文档文件(以下简称“软件”)副本的任何人免费权利,可以在不受限制的情况下处理软件,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本,并允许向软件提供的人这样做,但需遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或实质性部分中。

软件按“现状”提供,不提供任何明示或暗示的保证,包括但不限于适销性、适用于特定目的和无侵权性保证。在任何情况下,作者或版权所有者不对任何索赔、损害或其他责任负责,无论源于合同、侵权或其他行为,无论源于、源于或与软件或软件的使用或其他交易有关。