TECH LAB

【Directual】APIに認証を追加する方法


実現したい内容

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

DB機能も備わっており、Directualのサイト上だけでAPIサーバーとしての機能構築は完結します。本記事では、APIのエンドポイントに認証を追加する方法を記載致します。

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

結論

  • レイヤーを追加
  • 認証方法、条件を追加

1.レイヤーを追加

Direcutalにおいて、エンドポイントの認証はレイヤーと呼ばれる一つのグループで管理されています。

一つのエンドポイントにレイヤーを複数持つことができ、レイヤーは受け取るカラム、出力するカラム、実行するシナリオ、認証方法がまとまったものとなります。

エンドポイントを作成する際、レイヤーを必ずひとつ追加する必要があります。

エンドポイント作成画面にて、Set up new layerという青いボタンをクリックします。

2.認証方法、条件を追加

レイヤーを追加すると、直下にある肌色の欄に値が入ります。

デフォルトでは、id isNotNull ;と入力されており、入力されたデータのうち、idがNullだった場合認証を弾く、という設定になっております。

肌色の欄の右側にある斜めの両矢印をクリックすると、認証の条件を変更できます。

今回はデフォルトの認証条件(idがNull以外ならば認証)を使いませんので、削除します。

上部、認証項目のうちidにカーソルを合わせ、xで削除します。

Add conditionをクリックします。

Select field nameから認証に使用するカラムを選択します。

カラムは使用するデータ構造によって変わります。

今回はPasswordを選択しました。

赤枠の中から、認証条件に使う条件式を選択します。

More operatorsをクリックすることで、配列の場合は認証する、といった特殊な条件を選択することも可能です。

今回は、=を選択します。

下部のテキストエリアに値を入力します。

今回は試しにpasswordと入力します。

以上で、認証の追加は完了です。

今回は、受け取ったデータのpasswordという項目に、passwordという文字列が入っている場合のみ認証される設定をしました。

値を変えたり、条件式を変えたりすることで、様々なパターンに対応が可能となります。