notion API + NEXT.js + netlify でブログ立ち上げ ② notion api確認

2022年3月4日

個人開発・自動化プロジェクト

初めに

前回の続きです。今回はNotion APIを利用する準備に取り掛かります。 APIで実行確認した後、Nextjsを利用するのでNotion SDKで利用できるようになるまでをゴールとします。

API準備

integration を作成

Notion APIを利用するためには、integrationというものを設定する必要があります。

利用する用途ごとにintegrationを作成し、Notionのdatabaseにintegrationからアクセスすることを許可することでAPIを利用することができるようになります。

integrationの作成は下記ページから。流れに沿っていけば、すぐ作成できると思います。

The AI workspace that works for you. | Notion

A tool that connects everyday work into one space. It gives you and your teams AI tools—search, writing, note-taking—inside an all-in-one, flexible workspace.

Notion

💡

privateかpublicかどちらで利用するか設定する箇所があるので、間違えないようにしましょう

APIを使って記事の一覧を取得するためには、databaseに記事を入れておく必要があります。

よくNotion API でブログ化されている方は、databaseにtableを使用されることが多いのですが、個人的に凄い管理しにくい...ズラッと並んでくれてたほうがわかりやすくね？ってことで、listを採用しています。どちらでも問題ないと思いますが、APIで返ってくる型が変わるかどうかは未検証です。

databaseを作成したら画面右上のShareから、作成したintegrationを指定して共有しましょう。

API実行

準備ができたので、とりあえずAPIを実行してみます。 Headは下記共通のよう。

Authorization: Bearer  secret__xxxxx
Notion-Version: 2021-05-13

なお、レスポンス結果はめちゃくちゃ長いので割愛。

database内一覧取得

POST [https://api.notion.com/v1/databases/](https://api.notion.com/v1/databases/44aabc65af1740d695ffaa136252a016/query){database_id}[/query](https://api.notion.com/v1/databases/44aabc65af1740d695ffaa136252a016/query)
{
	"sorts": [
		{
			"timestamp": "last_edited_time",
			"direction":"ascending"
		}
	]
}

ページ情報取得

GET [https://api.notion.com/v1/pages/](https://api.notion.com/v1/pages/0cc5fc5b2ca1420fa242781160d16bc3){block_id}

ページもブロックの一つと捉えるらしいので、block_idにはpageのidを入れます。

子ブロック一覧取得

GET [https://api.notion.com/v1/blocks/](https://api.notion.com/v1/blocks/e5aba4f5e3c441bb9f4841157b2f5482/children){block_id}[/children](https://api.notion.com/v1/blocks/e5aba4f5e3c441bb9f4841157b2f5482/children)

ページもブロックの一つと捉えるらしいので、block_idにはpageのidを入れます。

Notion SDK

...と、ここまでAPIを実際に叩いて確認してきましたが、javascript / typescript に関しては、Notionがsdkを用意してくれています。

GitHub - makenotion/notion-sdk-js: Official Notion JavaScript Client

Official Notion JavaScript Client. Contribute to makenotion/notion-sdk-js development by creating an account on GitHub.

GitHub

今回はNextjsで利用するので、ありがたくこのsdkを利用することにします。

yarn add @notionhq/client

使用してみる

Notion用のヘルパクラスを作ります。

import { Client } from "@notionhq/client"
import type {
  QueryDatabaseResponse,
  ListBlockChildrenResponse,
} from '@notionhq/client/build/src/api-endpoints.d'

export default class Notion {
  private _notion: Client;
  private _token: string;
  private _databaseId: string;

  constructor(token: string, databaseId: string) {
    this._token = token;
    this._databaseId = databaseId;

    this._notion = new Client({
      auth: this._token
    });
  }

  public async getPostList() {
    const response: QueryDatabaseResponse = await this._notion.databases.query({
      database_id: this._databaseId,
      filter: {
        and: [{
          property: 'Published',
          checkbox: { equals: true }
        }],
      },
      sorts: [
        {
            "timestamp": "created_time",
            "direction":"descending"
        }
      ]
    });
    return postList;
  }

  public async getPostBlockListById(id: string) {
    const response: ListBlockChildrenResponse = await this._notion.blocks.children.list({
      block_id: id
    });
    return response;
  }
}

とりあえず記事一覧と記事内子ブロック一覧の取得メソッドを作成。

一旦ガワだけ。詳細は記事ページ作り込むときにでも。

仮の画面作成

とりあえず一覧画面と記事画面

作り込みは後日

合わせて読みたい

初めに