Project Icon

laravel-notion-api

Laravel项目无缝集成Notion API的高效解决方案

laravel-notion-api是一个专为Laravel框架设计的Notion API集成包。它提供了数据库查询、页面操作和搜索等核心功能,并支持灵活的过滤和排序。兼容Laravel 8、9和10版本,要求PHP 8.0及以上。通过简便的安装流程,开发者可以快速在Laravel项目中实现Notion功能,提升开发效率。该包为Laravel与Notion的协同工作提供了便捷解决方案。

Laravel 的 Notion 集成

Laravel 的 Notion 集成

运行测试 Packagist 最新版本 总下载量

这个软件包提供了一种简单明了的方式来访问 Notion API 端点、查询数据和更新现有条目。

文档

有关详细文档、更多背景信息和使用示例,请访问官方文档网站 notionforlaravel.com

快速入门指南

所有示例都参考我们的测试数据库,您可以在这里找到。

安装

该软件包兼容 Laravel 8、9 和 10。最低 PHP 要求是 8.0。

  1. 通过 composer 安装软件包:

    composer require fiveam-code/laravel-notion-api
    
  2. 按照 Notion 文档 中的说明获取您的 Notion API 访问令牌。同样重要的是,要在您的 Notion 页面中为集成授予访问权限,这在 Notion 的开发者文档中也有描述。

  3. 在应用程序的 .env 文件中添加一行:

    NOTION_API_TOKEN="$YOUR_ACCESS_TOKEN"
    
  4. 准备就绪!现在您可以通过 Notion facade 访问 Notion 端点:

    use \Notion;
    
    Notion::databases()->find("8284f3ff77e24d4a939d19459e4d6bdc");
    

    就是这样。

有关详细使用信息和可用端点列表,请参阅(文档)。

示例

获取 Notion 数据库

databases()->find() 方法返回一个 FiveamCode\LaravelNotionApi\Entities\Database 对象,其中包含数据库的所有信息,包括其属性和每个属性的可能值。

use \Notion;

Notion::databases()
        ->find("8284f3ff77e24d4a939d19459e4d6bdc");

获取 Notion 页面

pages()->find() 方法返回一个 FiveamCode\LaravelNotionApi\Entities\Page 对象,其中包含页面的所有信息,包括其属性和每个属性的可能值。

Notion::pages()
        ->find("e7e5e47d-23ca-463b-9750-eb07ca7115e4");

搜索

search() 端点返回与搜索查询匹配的页面集合。搜索范围限于安装了集成的工作区以及与集成共享的页面。

Notion::search("搜索词")
        ->query()
        ->asCollection();

查询数据库

database() 端点允许您查询特定数据库,并返回页面(=数据库条目)的集合。您可以过滤和排序结果,并限制返回的条目数量。有关可用过滤器和排序的详细信息,请参阅文档

use FiveamCode\LaravelNotionApi\Query\Filters\Filter;
use FiveamCode\LaravelNotionApi\Query\Filters\Operators;

$nameFilter = Filter::textFilter('Name', Operators::EQUALS, 'Ada Lovelace');

\Notion::database("8284f3ff77e24d4a939d19459e4d6bdc")
    ->filterBy($nameFilter)
    ->limit(5)
    ->query()
    ->asCollection();

还可以使用复合过滤器进行 AND 或 OR 查询:

use Illuminate\Support\Collection;
use FiveamCode\LaravelNotionApi\Query\Filters\Filter;
use FiveamCode\LaravelNotionApi\Query\Filters\FilterBag;
use FiveamCode\LaravelNotionApi\Query\Filters\Operators;
use FiveamCode\LaravelNotionApi\Query\Sorting;

# 查找所有满足以下条件的条目:
# (KnownFor == UNIVAC || KnownFor == ENIAC)
# 并按名称升序排序

$filterBag = new FilterBag(Operators::AND);

$filterBag->addFilter(
    Filter::rawFilter("Known for", [
        "multi_select" => [Operators::CONTAINS => "UNIVAC"],
    ])
);

$filterBag->addFilter(
    Filter::rawFilter("Known for", [
        "multi_select" => [Operators::CONTAINS => "ENIAC"],
    ])
);

\Notion::database("8284f3ff77e24d4a939d19459e4d6bdc")
    ->filterBy($filterBag)
    ->sortBy(Sorting::propertySort('Name', 'ascending'))
    ->limit(5)
    ->query()
    ->asCollection();

测试

您可以通过查看 /tests 目录中的软件包测试找到更多使用示例。我们使用 Pest 进行测试,目前正在将所有现有的 PHPUnit 测试转换为 Pest。

如果您想在命令行中运行测试:

vendor/bin/pest tests

支持

由 Tinkerwell 支持

Tinkerwell

这个软件包的开发得到了 Tinkerwell 的支持。

贡献

请查看 CONTRIBUTING 了解详情。

安全

如果您发现任何与安全相关的问题,请发送电子邮件至 hello@dianaweb.dev,而不是使用问题跟踪器。

致谢

许可证

MIT 许可证 (MIT)。更多信息请查看 许可证文件

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号