README

官方文档

Hostfact API 文档

安装

使用 composer 安装

composer require hyperized/hostfact

此包支持包自动发现（Laravel 5.5+），因此不需要您手动添加 ServiceProvider 和别名。

如果您使用的是较低版本的 Laravel 或未使用自动发现，可以将 Hostfact Service Provider 添加到 config/app.php 文件中

Hyperized\Hostfact\HostfactServiceProvider::class,

在 config/app.php 中为 Hostfact 注册一个别名

'Hostfact'    => Hyperized\Hostfact\HostfactServiceProvider::class,

现在将 Hostfact 包发布到您的安装中

php artisan vendor:publish --provider="Hyperized\Hostfact\HostfactServiceProvider" --tag="config"

您应该会收到如下消息：已复制文件 [/vendor/hyperized/hostfact/config/Hostfact.php] 至 [/config/Hostfact.php]

您可以在 config/Hostfact.php 文件中编辑配置变量，或者可以使用 HOSTFACT_URL 和 HOSTFACT_KEY 环境变量在 .env 文件中存储敏感信息

// config/Hostfact.php
'api_v2_url'		=> env('HOSTFACT_URL', 'https://yoursite.tld/Pro/apiv2/api.php'),
'api_v2_key'		=> env('HOSTFACT_KEY', 'token'),
'api_v2_timeout'	=> env('HOSTFACT_TIMEOUT', 20),

// .env/.env.example
HOSTFACT_URL=https://yoursite.tld/Pro/apiv2/api.php
HOSTFACT_KEY=token
HOSTFACT_TIMEOUT=20

功能

在为此 Hostfact 包编写代码时，请注意此包已编写为基本接口。

此包会做以下事情

提供一个方便的方式来与 Hostfact API 控制器通信；
使用方法记录可用的 API 控制器端点；
传输层（HTTP/HTTPS）错误捕获；
基本错误解析；

此包不会

参数/输入验证；
输出验证；

您需要查阅 Hostfact API 文档来了解每个 API 控制器的可接受输入和输出。

示例

示例代码

use \Hyperized\Hostfact\Api\Controllers\Product;

$products = Product::new()
                ->list([
                    'searchfor' => 'invoice'
                ]);

hyperized / hostfact

维护者

详细信息

README

官方文档

安装

功能

示例

许可证