クラッシュコース101
10 モジュール
5 週

一般情報

クリックでコピー

エンドポイント入門


最後のモジュールは、最初のビジネスプロセスを作成することで終了しました。プロセスロジックを作成し、特定の入力パラメータを受け入れ、計算を実行し、答えを発行する方法を理解しました。あとは、主な質問に答えるだけです。作成したビジネスプロセスをどのようにアクティブにし、動作させるか?

この問題を解決するために、アプリケーションとのインタラクションのキーポイントであるエンドポイントが意図されています。最初のモジュールでは、すでに外部APIと相互作用しています。これは、エンドポイントの存在のおかげで可能でした。ドキュメントを読んで、特定のリソースにアクセスするために、どのメソッドとどの URL にリクエストを送る必要があるのかを理解しました。

理解のために、具体的な例を使ってエンドポイントの実装を見てみましょう。第3モジュールでは、データベースモデルを作成しました。同時に、テーブルの作成と同時に、テーブルと対話するためのエンドポイントも自動的に作成されました。エンドポイントのセクション(左側のパネル)に移動して、それらを見てみましょう。


都市に関する情報を持つ "city" テーブルの例では、基本的なデータ操作のためのエンドポイントが既に6つあることがわかります。

  • GET /city- テーブルからすべてのデータを取得する
  • GET /city/:id- 指定したidの都市に関するデータを取得する
  • POST /city- テーブルに新しいレコードを追加する
  • PUT /city/:id- テーブル内の指定したidのレコードの完全な置き換え
  • PATCH /city/:id- テーブル内の指定されたidを持つレコードの部分的な置き換え
  • DELETE /city/:id- テーブルから指定されたidを持つレコードを削除する

一般的な設定

各エンドポイントの設定を開いて、より詳細に検討することができます。例えば、エンドポイント GET /city/:id


この図は、外部APIへのリクエストを作成したときに見たものと非常によく似ています。あるケースでは、既製のエンドポイントにアクセスしただけでしたが、今度はこのエンドポイントを自分で作成し、設定することになります。設定するためには、指定する必要があります。

  1. リクエスト・メソッド。この例では、GET メソッドです。
  2. リクエストURL。サーバーへのパスを含む最初の部分は指定されていません。これは、すべてのアプリケーションのエンドポイントに共通です。末尾(/city )だけを指定すれば十分です。URLパラメータもここで指定します。エンドポイントは特定の都市に関する情報を受け取るためのものなので、": "の後に書かれたその都市のIDがパラメータとして渡されます。
  3. Endpoint Groups.このパラメータは、エンドポイントの動作に何ら影響を与えるものではなく、組織の利便性のみを目的としたものです。すべてのエンドポイントは、テーマ別のグループ (フォルダ) に分けることができます。この例では、"city" グループに、都市に関するデータを操作するためのすべてのエンドポイントが含まれています。
  4. Business Process.これは最も重要な設定項目であり、エンドポイントにリクエストを送信する際に、どのような形でも見ることができなかったものです。ビジネスプロセスの指示は、このエンドポイントが何を行うかを決定します。同時に、エンドポイント自体は変更されず、古いアドレスで同じリクエストをすべて受け取ることができ、同時に、ビジネスプロセスが置き換えられた場合、完全に異なる機能を実行することになります。基本的なデータベース活動のためのビジネスプロセスは自動的に作成される。これをシステムビジネスプロセスと呼ぶ。このようなBPは変更できないが、独自に作成したカスタムビジネスプロセスでいつでもBPを置き換えることができる。
  5. Input/Output variables.作成されたビジネスプロセスは、様々な入出力変数を使用しますが、エンドポイントはそのすべてを使用する必要はありません。パートを無効にしたり、異なるエンドポイントが同じBPにアクセスし、個別の変数セットを使用するように設定することができます。リクエストとレスポンスのタイプ (Request / Response type) もそこで設定されます。ほとんどの場合、このタイプはJSONですが、必要に応じて、XMLやRender File (このタイプのレスポンスは、ファイルを扱うためのエンドポイントで使用されます)のような他のオプションを使用することができます。

ミドルウェアの設定

エンドポイントを作成し、さらに使用するためには、一般的な設定で十分ですが、必要に応じて追加のパラメータを使用することができます。その中で最も重要なのは、Auth トークンを使ったMiddleware の有効化です。


これを使用すると、認証されていないユーザーや特定のグループに属していないユーザーに対して、このエンドポイントへのアクセスを拒否することができます(たとえば、管理者のみにアクセスを許可し、その他のユーザーにはアクセスを拒否することができます)。

ロギングと出力の設定

さらに、Settings タブの設定を使用して、ログヘッダーまたはリクエストボディを追加したり、値が設定されていないフィールドをレスポンスから非表示にしたりすることができます。


Was this article helpful?
まだ答えをお探しですか?