Advance configure
Full project tutorial
Release Notes
Advanced configure
チュートリアル
APIエンドポイントは、アプリケーションのサーバープロセスをフロントエンド(Webまたはモバイルアプリケーション自体)に接続するゲートウェイの一種です。各エンドポイントはそれぞれのテーブルと関連付けられます。
各エンドポイントには、ルート/URL、メソッド(GET
、POST
、PUT
、またはDELETE
)、モデルメソッド、リクエストパラメータ、レスポンスパラメータがあります。
少なくとも1つのテーブルを作成してください(テーブルの設定を参照してください)。
APIエンドポイントを表示するには、「API endpoints」メニューに移動してください。デフォルトでは、データベーステーブルから生成された既存のエンドポイントグループが左のペインに表示されます。
左ペインのエンドポイントグループをクリックすると、右ペインにエンドポイントリストが表示されます。
エンドポイント リストにて、エンドポイントのステータスを「ON」に切り替えて、そのエンドポイントを有効にしてください。
エンドポイントを無効にするには、「OFF」にステータスを切り替えてください。
エンドポイントリストには、有効化および構成可能な5つの事前構成エンドポイントがあります。以下は、usersテーブルの例です:
/api/users
/api/users
/api/users/:id
/api/users/:id
/api/users/:id
APIエンドポイントを設定するには、「Edit」アイコンをクリックしてください。
設定パネルが右側に表示されます。
エンドポイントを削除するには、「Edit」アイコンの近くにある「削除」アイコンをクリックしてください。
HTTPリクエストメソッドを設定するには、セレクトボックスからHTTPメソッドを選択してください。
URLリクエストを設定するには、inputフォームにリクエストURLを指定してください。
HTTP メソッドのオプション:
エンドポイントのリクエストパラメータのオプションには、名前とデータ型を入力してください。
「Auto-fill」リンクをクリックして、リクエストパラメータとして送信するJSONオブジェクトをテキストエリアフィールドに入力することもできます。
GETモデルメソッドのフィルタ機能を設定するには、下記の3つのセクションを設定します。
入力フィールド
GET
、POST
、PUT
、GET
、DELETE
)テーブルは、設定された条件に一致するテーブルレコードのリストをフィルタリングするために使用されます。
カラム定義
Condition
— 1つまたは複数の条件に基づいてレコードをフィルタリングするために使用されるANDおよびOR演算子の2つのオプションがあります。
Column definition
— レコードをフィルタリングするために使用するテーブルの列Query
— レコードをフィルタリングするために使用するクエリは、選択した列定義のカラムタイプに基づくオプションに基づいています(クエリオプションリストを参照してください)。Value
— ステップごとに設定されたリクエストパラメータの値リクエストパラメータの設定クエリオプション
String
, Text
Integer
, Float
, Date
, Datetime
File
Enum
コンディションを削除するには、「ゴミ箱」ボタンをクリックしてください。コンディションの行はコンディションテーブルから消えます。
ページネーションとテーブルレコード結果の並べ替え
入力フィールド
Page
— テーブルのレコード結果のページ数Limit
— 1ページあたりのテーブルレコード結果の上限Order by
— 選択したカラムに基づいてテーブルレコードをソートするOrder
— 以下のオプションに基づいてテーブルレコードをソートするGETメソッドのshow機能は、以下の2つの領域を設定できます。
GEYメソッドのAssociated modelの設定と同じように、showアクションの設定もできます。
カラム定義