kylefang/notion-api-worker
1
0
Fork 0
mirror of https://github.com/zhigang1992/notion-api-worker.git synced 2026-01-12 17:32:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Timo
2020-04-21 15:07:54 +02:00
committed by GitHub
parent 2129ba84e5
commit 40bc9c63be
1 changed files with 24 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -1,34 +1,49 @@
![Notion API Worker](https://user-images.githubusercontent.com/1440854/79867270-634a1800-83de-11ea-98ad-42209b9f32a7.png)
# notion-cloudflare-worker
A serverless layer on top of the private Notion API. It leverages [Cloudflare Workers](https://workers.cloudflare.com/), to provide fast and easy access to all your Notion content.
A **serverless wrapper** for the the private Notion API. It provides fast and easy access to your Notion content. Ideal if you want to use Notion as CMS.
It's powered by [Cloudflare Workers](https://workers.cloudflare.com/).
_This package might become obsolete, once the official Notion API arrives._
## Features
🍭 **Easy to use** – Receive Notion data with a single GET request
✨ **Fast CDN** – Leverage the global Cloudflare CDN
🛫 **CORS Friendly** – Access your data where you need it
🗄 **Table Access** – Get structured data from tables & databases
✨ **Fast CDN** – Leverage the global Cloudflare CDN
🛫 **CORS Friendly** – Access your data where you need it
## Use Cases
- Use a table to manage posts for your blog
- Create a table with pages that include date and additional metadata. Perfect if you want to render a list of all available posts.
- Get page content that can be rendered with [`react-notion`](https://github.com/splitbee/react-notion)
## Endpoints
We provide a hosted version of this project on [https://notion.splitbee.io/](https://notion.splitbee.io/). You can also [host your own](https://workers.cloudflare.com/). Cloudflare offers a generous free plan with up to 100,000 request per day.
We provide a hosted version of this project on [`https://notion-api.splitbee.io`](https://notion-api.splitbee.io/). You can also [host your own](https://workers.cloudflare.com/). Cloudflare offers a generous free plan with up to 100,000 request per day.
### Get data from a page - `/v1/page/<PAGE_ID>`
### Load Page - `/v1/page/<PAGE_ID>`
[Example](https://notion.splitbee.io/v1/page/2e22de6b770e4166be301490f6ffd420)
[Example](https://notion-api.splitbee.io/v1/page/2e22de6b770e4166be301490f6ffd420)
Returns all block data for a given page.
For example, you can render this data with [`react-notion`](https://github.com/splitbee/react-notion).
### Get parsed data from table `/v1/table/<PAGE_ID>`
### Loage Table `/v1/table/<PAGE_ID>`
[Example](https://notion-api.splitbee.io/v1/page/2e22de6b770e4166be301490f6ffd420)
Returns the given Table page as object array. The column names serve as key for those object.
[Example](https://notion.splitbee.io/v1/page/2e22de6b770e4166be301490f6ffd420)
## Credits