エンドポイントは、一般にビジネスプロセスやアプリケーション開発において不可欠な要素です。この記事では、エンドポイントとは何か、なぜ必要なのか、AppMaster.io プラットフォームで作成する方法について定義します。

エンドポイントとは何か

エンドポイントとは、アプリケーションのサーバー プロセスと外部インターフェースを接続するゲートウェイのことを指します。言い換えれば、これはリクエストが送信されるアドレスです。

エンドポイントが何であるかを理解するために、APIがどのように機能するかについて言及することが重要です。APIとは、アプリケーション・プログラミング・インターフェースの略称です。アプリケーションはAPIを使用して、第三者のサービスやそのユーザーと対話します。

APIに接続するには、リクエストを送信する必要があります。リクエストを正しく処理するために、クライアントはユニバーサルリソースポインタ(URL)、HTTPメソッドを提供し、メソッドに応じて、ヘッダー、ボディ、リクエストパラメータを追加する必要があります。

Endpoints in API: how it works

APIはリクエストを処理し、サーバーから受け取ったレスポンスを送信します。レスポンスにはステータスコードが含まれ、これはリクエストの結果をクライアントに通知するHTTPレスポンスメッセージの一部です。例えば、操作が正常に完了した場合は200、サーバーの内部エラーが発生した場合は500のコードが使用されます。

エンドポイントはAPIメソッドと一緒に動作します。これらは、アプリケーションがサードパーティーのサービスやユーザーと通信するために使用する特定の URL です。URL は、さまざまなリクエスト メソッドを処理できるルートです。各リクエストタイプは、個別のエンドポイントです。主なタイプは5つあります。

  • GET - サーバーから情報を取得します; リクエストボディを必要としません;
  • POST - データベースに新しいオブジェクトを作成し、このオブジェクトのフィールドでリクエストボディを必要とします;
  • PUT - データベース内の特定のオブジェクトを完全にリセットします;
  • PATCH - PUT と同様に、データベース内の特定のオブジェクトをリセットしますが、リクエストボディに記載されるフィールドのみ更新します;
  • DELETE - データベースからオブジェクトを削除します;
  • Delete: データベースにあるオブジェクトを削除します。

特定のリクエストを作成するとき、さまざまなパラメーターを追加することができます。これらのパラメータとURLの組み合わせは、URI(Uniform Resource Identifier)を表します。

Endpoints and URL

AppMaster.io プラットフォームでエンドポイントを設定するには?

AppMaster.io プラットフォームのエンドポイントセクションでは、すべての自動生成エンドポイントと自分のプロジェクトのエンドポイントを確認することができます。プロジェクト内のスクリーンとページの自動生成が有効な場合、作成されたデータモデルに対応するエンドポイントが自動的に作成される。

Endpoints in AppMaster.io

AppMaster.com

は、AppMaster.comで提供されているアプリケーションに対応するエンドポイントです。

  • クライアントやサードパーティシステムからバックエンドにアクセスするためのAPI、
  • サードパーティシステムから通知を受け取るためのwebhooks、 >サーバーに応答を求めずにブラウザとサーバー間で双方向インタラクティブ通信セッションを開くための
  • WebSocket、などです。

Endpoint types

すべてのエンドポイントはグループ化されています。各グループ内には、対応するすべてのエンドポイント、そのリクエスト タイプ、URL、およびそれらが接続されているビジネス プロセスがあります。

エンドポイントを作成または編集する場合、設定ウィンドウで次のオプションが利用可能です:

  1. リクエストメソッド。GET、POST、PUT、DELETE、または PATCH。
  2. リクエスト URL。サーバーへのパスを含む最初の部分は、すべてのアプリケーションエンドポイントで同じであるため、指定されません。例えば /users のように末尾を設定するだけで十分です。また、URLのパラメータもここで指定します。エンドポイントが、特定のユーザーに関する情報を受信するように設計されているとします。その場合、その ID を ":" の後に記述し (/users/:id) 、パラメーターとして渡さなければなりません。
  3. エンドポイント グループ。このパラメータは、エンドポイントでの作業を整理し、構造化することを目的としています。すべてのエンドポイントはグループ (フォルダー) に分けることができます。
  4. ビジネス プロセス。エンドポイントが何を行うかを決定する最も重要なパラメーターの 1 つです。同時に、エンドポイント自体は変更されないままであることも可能です。古いアドレスで同じリクエストをすべて受信し、ビジネスプロセスが交換された場合は、異なる機能を実行することになります。基本的なデータベース操作のためのビジネスプロセスは、自動的に作成されます。それらを編集することはできませんが、必要に応じてカスタムBPに置き換えることができます。

Edit endpoint

またミドルウェアもセットアップが可能です。ミドルウェアとは、アプリケーションのリクエストを処理する際にフィルタリングの役割を果たす中間的なソフトウェアのことである。ミドルウェアは、リクエストを実行する前に何らかの条件をチェックするために使用される。例えば、ユーザー認証をチェックするミドルウェアを作成した場合、ユーザーがログインしていなければ、ミドルウェアはユーザーをログインページにリダイレクトさせる。ログインしている場合は、ミドルウェアはリクエストの処理に干渉せず、クライアントに渡します。

Editing endpoint

AppMaster.io でエンドポイントを作成する

実際にエンドポイントの構成を考え、Aviato プロジェクトの例を通して分析してみましょう。

プロジェクト内で、2 つのビジネス プロセスを作成しました。

  • Validate and create flights - Create flight business process を置き換えるために使用されるプロセス
  • Register passenger - 特定のフライトに乗客を登録するためのプロセス

エンドポイントを作成する方法について説明します。apms.io/api/_files/KZPFsPa3DTD7MH6QhDaKth/download/" title="Business processes in AppMaster.png" width="1600" height="783" alt="Business processes example" data-mce-src="https://ws.apms.io/api/_files/KZPFsPa3DTD7MH6QhDaKth/download/">

Now we can use these processes to set up endpoints in the project.

まず、validate and create flights business processから見ていきましょう。フライトグループには、フライトを作成するための POST/flights エンドポイントがすでにあります。ここで、添付されているビジネスプロセスを新しいものに置き換える必要があります。

構成ウィンドウで、必要なビジネスプロセスを選択します。この場合、これはValidate and create flights BPです。その後、必要な入力変数をすべて選択し、変更を保存する必要があります。

Business processes and endpoints

ここで、乗客登録ビジネスプロセスの次のエンドポイントを設定します。

我々の目標は、特定のフライトとそれに関連する乗客を表示するセクションを作成して、新しい乗客を登録するプロセスを設定することです。

Flightsエンドポイント グループに、新しいエンドポイントを作成する必要があります。/ここで、id はビジネス プロセスの入力として使用できる特定のフライトを指します。

プラス アイコンをクリックすることにより、新しいエンドポイントを追加できます。新しいオブジェクトを作成しているため、要求メソッドは POST になります。

New API endpoint

AppMaster.iO プラットフォームでのエンドポイント作成がいかに簡単であるかということがわかりますね。フル動画チュートリアル:

Conclusion

EndpointはAPIの運用で重要な役割を果たし、それは逆にプロジェクトの拡大とサービスおよびアプリケーションの統合の便利さに必要であると言えます。ノーコード プラットフォームの AppMaster.io では、エンドポイントの作成と設定を簡単に行うことができます。いつでもプラットフォームに登録し、すべての機能を確認することができます。