Getting Started

Database

Modules

API Endpoints

Mobile Editor

Web Editor

Localizations

Organization & Team

Export

Figma Import

Advance configure

Email Authentication

Phone authentication

Full project tutorial

Project overview

Create project

Configure database

Configure modules

Configure API endpoints

Import from Figma

Configure using Editor

Export and running

Release Notes

Release Notes

ようこそ、JITERAへ!

はじめに

データベース

モジュール

API エンドポイント

Mobile エディター

Web エディター

ローカライゼーション

組織とチーム(Organization & Team)

エクスポート

Advanced configure

Google Analytics モジュール

Email 認証

電話番号認証

チュートリアル

プロジェクト概要

プロジェクトの作成

データベース設定

モジュールの設定

APIエンドポイントの設定

Figmaインポート

エディタ設定

エクスポートと起動

API エンドポイントとは?

APIエンドポイントは、アプリケーションのサーバープロセスをフロントエンド(Webまたはモバイルアプリケーション自体)に接続するゲートウェイの一種です。各エンドポイントはそれぞれのテーブルと関連付けられます。

各エンドポイントには、ルート/URL、メソッド(GETPOSTPUT、またはDELETE)、モデルメソッド、リクエストパラメータ、レスポンスパラメータがあります。


前提条件

少なくとも1つのテーブルを作成してください(テーブルの設定を参照してください)。


エンドポイントを表示

APIエンドポイントを表示するには、「API endpoints」メニューに移動してください。デフォルトでは、データベーステーブルから生成された既存のエンドポイントグループが左のペインに表示されます。

Untitled

左ペインのエンドポイントグループをクリックすると、右ペインにエンドポイントリストが表示されます。

APIエンドポイントを有効化/無効化する

エンドポイント リストにて、エンドポイントのステータスを「ON」に切り替えて、そのエンドポイントを有効にしてください。

Untitled

エンドポイントを無効にするには、「OFF」にステータスを切り替えてください。

エンドポイントリストには、有効化および構成可能な5つの事前構成エンドポイントがあります。以下は、usersテーブルの例です:


APIエンドポイントの設定と削除

APIエンドポイントを設定するには、「Edit」アイコンをクリックしてください。

Untitled

設定パネルが右側に表示されます。

Untitled

エンドポイントを削除するには、「Edit」アイコンの近くにある「削除」アイコンをクリックしてください。


HTTPメソッドとURLの設定

HTTPリクエストメソッドを設定するには、セレクトボックスからHTTPメソッドを選択してください。

URLリクエストを設定するには、inputフォームにリクエストURLを指定してください。

Untitled

HTTP メソッドのオプション:


リクエストパラメータの設定

エンドポイントのリクエストパラメータのオプションには、名前とデータ型を入力してください。

Untitled

「Auto-fill」リンクをクリックして、リクエストパラメータとして送信するJSONオブジェクトをテキストエリアフィールドに入力することもできます。

Untitled


モデルメソッドの設定

検索アクション付きの GET メソッド

GETモデルメソッドのフィルタ機能を設定するには、下記の3つのセクションを設定します。

  1. Associated model(モデルとその関係)
  2. Query(クエリ)
  3. Pagination(ページネーション)

Associated model(モデルとその関係)

Untitled

入力フィールド

Query(クエリ)

テーブルは、設定された条件に一致するテーブルレコードのリストをフィルタリングするために使用されます。

Untitled

カラム定義

クエリオプション

コンディションを削除するには、「ゴミ箱」ボタンをクリックしてください。コンディションの行はコンディションテーブルから消えます。

ページネーションと並べ替え

ページネーションとテーブルレコード結果の並べ替え

Untitled

入力フィールド


showアクションを使用したGETメソッド

GETメソッドのshow機能は、以下の2つの領域を設定できます。

  1. Associated model(モデルとその関係)
  2. Query(クエリ)

Associated model(モデルとその関係)

GEYメソッドのAssociated modelの設定と同じように、showアクションの設定もできます。

Untitled

Query

Untitled

カラム定義