開発者はじめに

コンテンツモデルから稼働中の API まで、数分で。

コンテンツレイヤーは JSON ベースの REST API です。インストールする SDK も、フレームワーク専用のクライアントもありません。コンテンツタイプを定義し、ページを生成し、すでにフロントエンドを描画している仕組みからシンプルな HTTP 呼び出しで取得するだけです。

01 / 全体の流れ

最初のリクエストまで 4 ステップ

ワークスペースを作成し、コンテンツタイプを定義し、レコードを追加して、テンプレートを紐づける。あとは GET リクエストひとつで、同じ公開ページを取得できます。

1. コンテンツタイプを作成

不変の ID を持つフィールドを定義します。編集者と API の利用者の両方が頼りにするスキーマです。

2. レコードを追加してテンプレートを紐づけ

レコードを作成してテンプレートを紐づけ、公開前に生成ページをプレビューします。

3. 公開済みページを取得

そのページについてサイトの公開コンテンツ API を呼び出します。シンプルな JSON で、どの環境でも同じ形式です。

02 / SDK なし、ロックインなし

今あるスタックでそのまま動く

静的生成、サーバーレンダリング、クライアントサイドでの取得。API は特定のフレームワークやホスティング先を前提にしていません。

どこでも同じ API

ローカル、ステージング、本番のすべてが同じバージョン付きの /v1 API と通信します。環境ごとのクライアントコードを保守する必要はありません。

どんなレンダリング戦略にも

ビルド時、リクエスト時、ブラウザから。どこで取得しても API は気にしません。

標準の HTTP 認証

ワークスペースのセッションかスコープ付き API キーで認証。独自のハンドシェイクを実装する必要はありません。

最初のリクエストを送る

実際に公開したページを取得しよう。

ワークスペースを開いてページを生成し、そのページに対して公開 API を呼び出してみましょう。