ドキュメント

API作成

プロジェクト内のAPIの作成方法をご説明します。

APIはプロジェクトごとに複数作成することができます。プロジェクトを作成した後、サイドメニューの「APIを追加」、または「新規追加」から、新規API作成画面を開きます。

1.基本情報入力

API名

任意のAPIの名称を入力してください。

エンドポイント

エンドポイントはAPIの最後尾のパスにあたる値です。以下の入力条件に従って入力してください。

  • 2文字以上64文字以内
  • 半角英数字、ハイフン、アンダースコアのみ
  • プロジェクト内での重複不可

2.APIの型を選択

APIの基本情報を設定したら、次にAPIの型を選択します。

リスト形式

JSON配列を返却するAPIを作成します。ブログ記事やお知らせの一覧などに適しています。

シングル形式

JSONオブジェクトを返却するAPIを作成します。サイト全体の設定項目や会社概要・単体ページ情報などに適しています。

3.APIスキーマを定義

続いて、APIスキーマを設定します。スキーマによって、APIレスポンスの構造を決めることができます。それぞれのフィールドで以下の項目を入力してください。

フィールド名

コンテンツを入力する際に表示される項目名です。

フィールドID

APIレスポンスのプロパティ名です。フィールドIDは半角英数字とアンダースコアのみ使用できます。

フィールドタイプ

コンテンツを入力する際の入力フォームを指定することが出来ます。
フィールドタイプの詳細については「APIスキーマのフィールドタイプ」のページを参照ください。

最後に「登録する」から内容を送信し、APIの作成は完了です。

まずは無料でお試しください

メールアドレスのみで簡単に登録できます。
データ設計と運用を簡単に行えるhacoCMSの機能を是非ご覧ください。