wqa/php-gitbook
Gitbook API 的 PHP 封装。
v1.0.0
2021-03-17 16:19 UTC
Requires
- guzzlehttp/guzzle: ^7.2
Requires (Dev)
- phpunit/phpunit: ^9.5
- vlucas/phpdotenv: ^5.3
This package is auto-updated.
Last update: 2024-09-18 18:24:32 UTC
README
注意:GitBook API 目前仍处于测试阶段,因此底层 API 和此封装可能随时更改。
安装
composer require wqa/php-gitbook
用法
创建客户端
$gitbook = new GitbookClient($secretKey);
获取当前用户
$gitbook->getCurrentUser();
获取用户
$gitbook->getUser($userUid);
获取当前用户的空格
$gitbook->getSpaces();
获取特定用户或组织的空格
$gitbook->getSpacesFor($userUid); $gitbook->getSpacesFor($organisationUid);
获取空格
$gitbook->space($spaceUid)->get();
获取空格修订版本
$gitbook->space($spaceUid)->primaryRevision()->get(); $gitbook->space($spaceUid)->revision($revisionUid)->get();
获取空格草稿修订版本
$gitbook->space($spaceUid)->draft($draftUid)->get();
获取空格变体
$gitbook->space($spaceUid)->primaryRevision()->getVariant(); $gitbook->space($spaceUid)->primaryRevision()->getVariant('spanish');
获取页面内容
$gitbook->space($spaceUid)->primaryRevision()->getPage($pageUid); $gitbook->space($spaceUid)->primaryRevision()->getPageByUrl($pageUrl); // Get page content for variant $gitbook->space($spaceUid)->primaryRevision()->getPage($pageUid, 'spanish'); $gitbook->space($spaceUid)->primaryRevision()->getPageByUrl($pageUrl, 'spanish'); // Get page content as markdown $gitbook->space($spaceUid)->primaryRevision()->getPage($pageUid, 'master', PageFormat::Markdown); $gitbook->space($spaceUid)->primaryRevision()->getPageByUrl($pageUrl, 'master', PageFormat::Markdown);
获取空格资产
$gitbook->space($spaceUid)->primaryRevision()->getAssets();