TECH LAB

【Directual】APIのエンドポイントを作成する方法


実現したい内容

Directualとは、ノーコードでAPIサーバーを構築できるサービスです。

DB機能も備わっており、Directualのサイト上だけでAPIサーバーとしての機能構築は完結します。本記事では、DBへレコードを挿入するAPIのエンドポイントの作成方法を記載致します。

Directualの概要に関しては、他の記事で紹介しておりますので、気になった方はそちらもご覧下さい。

結論

  • アプリケーションを作成する。
  • APIのエンドポイントを作成する。
  • プレビュー画面でAPIの動作確認をする。

1.アプリケーションを作成する。

Directualにサインインすると、画面の上部にCreate a blank appという青色のボタンが出てきます。

そちらをクリックし、アプリケーション情報を入力します。

Create a blank appボタンをクリックすると、下記画面が表示されます。

それぞれアプリケーション情報を入力します。

System nameは他ユーザーが作成したアプリケーションと同じものは使えませんので、Errorが発生した際は変更する必要があります。

Use a templateのラジオボタンを選択することによりテンプレートを用いたアプリケーション作成も可能ですが、今回はテンプレートを使用せずに作成します。

入力後、右上のCreate appボタンをクリックします。

2.APIのエンドポイントを作成する

作成したアプリケーションを選択します。今回はdirectualapptestというアプリケーションを作成しました。

選択すると以下のような画面が出てきますので、API-layerの中のAPI-endpointsをクリックします。

APIのエンドポイント一覧ページが表示されますので、New API-endpointをクリックします。

APIの情報を入力する画面が表示されます。

Destination data structureでDBのデータ構造を選択できます。Directualでは、既にいくつかのデータ構造が作成されておりますので、今回はその中からApp global constants [GlobalVariables]を選択します。

選択後、APIの詳細情報を入力する欄が出てきますので、入力していきます。

その後、Set up new layerという青いボタンをクリックします。

Conditions on user's sessionという項目で、APIで受け取るデータの正当性をチェックできるのですが、記事が長くなってしまうため今回はデフォルトのまま進めます。

GET Fields for readingにて、APIからDBのデータ出力、
POST Fields for writingにて、APIからDBへのデータ挿入の設定を行えます。
 
それぞれ、+Add fields for readingと+Add fields for writingをクリックすることによりデータ構造の中から出力、挿入するカラム名を設定できます。
 
 
Scenarios for running in sync-modeは、APIにより取得したデータに対してのバックエンドロジックを設定できるのですが、今回はバックエンドロジックを作成していないので、空欄にしときます。
 
ここまで設定できましたら、上部のSaveという青いボタンをクリックします。
3.プレビュー画面でAPIの動作確認をする。
Directualでは、サイト上でAPIの動作確認が可能です。
上部のEndpoint respond previewボタンをクリックしてください。
そうすると、下記画面が表示されます。
App user IDに1を入力し、create new app user with this IDにチェックを入れ、Sendボタンをクリックすると、API responseにAPIからのレスポンスが表示されます。
 
以上で、APIのエンドポイント作成は完了となります。
その他、細かな設定方法に関しては別記事にて紹介したいと思います。
 

Get notified on new marketing insights

Be the first to know about new B2B SaaS Marketing insights to build or refine your marketing function with the tools and knowledge of today’s industry.