README

此包为与 Better Proposals 提案管理系统及其 API 交互提供了流畅的方式。

安装

您可以通过 composer 安装此包

composer require bernskioldmedia/laravel-better-proposals

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="better-proposals-config"

这是已发布的配置文件的内容

return [

    /**
     * The API key used for authenticating with the Better Proposals API.
     */
    'api_key' => env('BETTER_PROPOSALS_API_KEY', ''),

    /**
     * The Base URL for the BetterProposals API including the version.
     * This package currently only supports V2 of the API.
     */
    'base_url' => env('BETTER_PROPOSALS_API_URL', 'https://api.betterproposals.io'),

];

用法

该包提供了一个方便的外观来与所有资源交互。该包将通过流畅的方法让您使用 API，但不会触及或映射来自 API 的响应。请参阅 Better Proposals API 文档以获取有关响应的更多信息。

当前，该包支持所有 Better Proposals API 资源。您的 IDE 应该在类型时在外观中找到它们。

当使用 all 方法获取列表时，还有一些流畅的过滤方法可以帮助您过滤。此外，一些资源还具有“操作”。这些函数的名称与 Better Proposals API 文档中的参数名称大致匹配。

use BernskioldMedia\BetterProposals\Facades\BetterProposals;

BetterProposals::companies()->all();

BetterProposals::proposals()->signed();

BetterProposals::proposals()->all();

BetterProposals::proposals()->create(['...']);

测试

composer test

bernskioldmedia / laravel-better-proposals

维护者

详细信息

README

安装

用法

测试

更新日志

致谢

许可证