コードなしでAPIを作成する方法

2月 03, 2022 4 ミン

内容

この記事では、プロレベルのノーコードプラットフォームであるAppMaster.ioでAPIを操作する方法を説明します。ただし、最初に、APIに関するいくつかの基本的な情報を思い出してみましょう。

序章

APIは、アプリケーションプログラミングインターフェイスを意味します。これらは、クライアントとサーバーが相互に通信する方法です。クライアントとサーバーはリクエストとレスポンスを送信し、APIはそれらの間の仲介役として機能します。

The model of REST API

このクライアント/サーバーの相互作用は、単純で、理解しやすく、便利でなければなりません。これにより、開発者のタスク（新しいサービスを再発明する必要がない）とユーザー（サービスが使い慣れていると習得しやすくなります）の両方が簡素化されます。 APIにはいくつかの種類があります。

WebサービスAPI、XML-RPC、およびJSON-RPC、SOAP。
WebSocket API;
ライブラリベースのAPI、Javaスクリプト。
クラスベースのAPI、C＃API、Java。

ノーコードAppMaster.ioプラットフォームでは、RESTAPIスタイルを使用します。

RESTまたはRepresentationalState Transfer全体は、クライアントとサーバー間の相互作用（情報交換）のアーキテクチャースタイルです。 REST APIのサービスは、HTTPプロトコルを使用して通信します。

スタイルRESTには特定の利点があります。 RESTの主な利点は、優れた柔軟性です。 RESTは単純なガイドラインで構成されており、開発者は要件を自分の形式で実装できます。 RESTは高性能であり、これは、たとえばモバイルデバイスでの高速ロードにとって非常に重要です。そのため、TwitterやGoogleなどのすべての大企業は、自社製品にRESTAPIを長い間実装してきました。 REST APIの作業と主な利点について詳しくは、記事をご覧ください。

リクエストの構造には、HTTPメソッド、エンドポイント、ヘッダーと本文、リクエストパラメータの5つの主要コンポーネントが含まれます。

REST APIは、4つの基本HTTPメソッドを使用してリソース（情報）を処理します。各メソッドは、リソースで何を実行する必要があるかを記述します。

POST —リソースの作成。
GET —リソースを取得します。
PUT —リソースの更新。
DELETE —リソースを削除します。

リソースとは、任意の情報（ドキュメント、画像、ビデオ、テキストなど）です。 AppMaster.ioノーコードプラットフォームでは、この情報は、最も一般的な形式であるJSONを含むいくつかの形式でクライアントに配信されます。

エンドポイントには、URI（Uniform Resource Identifier（Uniform Resource Identifier））が含まれています。これは、インターネット上のリソースを見つける場所と方法を示し、URLを含みます（URLまたはUniform Resource Locationは完全なWebアドレスです）。

ヘッダーは、クライアントとサーバーの両方に情報を伝達します。ヘッダーは主に認証データ（APIキー、サーバーがインストールされているコンピューターの名前またはIPアドレス、および応答形式）を提供します。

本体は、サーバーに追加情報を渡すために必要です。本体データは、たとえば、追加または置換するデータです。

プラットフォーム上のアプリケーションのAPIドキュメントは自動的に生成され、OpenAPI（Swagger）形式でバックエンドに保存されます。

AppMaster.ioでAPIを構築する方法を学ぶために、それがどのように機能するかを正確に理解する必要はありません。プラットフォームのツールについて学ぶことで、基本的な原則を理解できます。さらに、APIの中心部分はAppMaster.ioによって作成されます。ほとんどの設定は、デフォルトで、またはモジュールを接続するときに行われます。 ‌たとえば、このモジュールは、メールのAPIと統合するためのツールを提供します。

アプリケーションを他のアプリケーションまたは外部リソースに統合（接続）する場合は、一部のAPI設定に手動で小さな変更を加える必要があります。次に、これを行う方法を見ていきます。