README

Twingly的搜索API（之前称为分析API）的PHP库。Twingly是一个博客搜索服务，提供名为Twingly Search API的可搜索API。

安装

通过Composer安装

php composer.phar require twingly/twingly-search

# Or if you have installed composer globally
composer require twingly/twingly-search

使用

use Twingly\Client;

$client = new Client();

$query = $client->query();
$query->search_query = 'github page-size:10 lang:sv';
$result = $query->execute();

foreach($result->posts as $post) {
    echo $post->url . "\n";
}

twingly-search库与商业博客搜索API通信，需要一个API密钥。最佳实践是将TWINGLY_SEARCH_KEY环境变量设置为获取到的密钥。\Twingly\Client可以在初始化时传递一个密钥，如果您的设置不允许使用环境变量。

此库使用phpdoc进行文档记录。要生成文档，请调用

phpdoc -d ./src -t ./docs

示例代码可在examples/中找到。

要了解API的功能，请阅读Twingly Search API文档。

要求

API密钥，通过注册 twingly.com 获取一个
PHP 7.x, 8.x

开发

在OS X上安装PHP和Composer

brew install php@7.4
brew install composer

安装项目依赖

composer install

运行测试

./vendor/bin/phpunit

运行示例

TWINGLY_SEARCH_KEY=<KEY> php examples/hello_world.php

发布

创建发布

twingly-search在Packagist上发布。

在Client.php中增加版本号，遵循语义版本化2.0.0。
创建与版本相同的标签并将其推送到GitHub
```
 git tag <VERSION> && git push --follow-tags
```
完成了！(此仓库有一个GitHub服务钩子，当创建新版本时会通知Packagist。)

更新更改日志

如果您还没有，安装GitHub Changelog Generator
- gem install github_changelog_generator
将CHANGELOG_GITHUB_TOKEN设置为个人访问令牌以增加您的GitHub API速率限制
生成更改日志
- github_changelog_generator

许可证

MIT许可证（MIT）

特此授予任何人免费获得此软件及其相关文档文件（以下简称“软件”）的副本的权利，用于在不限制的情况下处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件的副本，并允许向提供软件的人员授予上述权利，前提是遵守以下条件

twingly / twingly-search

维护者

详情

README

安装

使用

要求

开发

发布

创建发布

更新更改日志

许可证