GeneXus では、
API オブジェクトを使用して
REST Web サービスを自動で作成できます。また、互換性の観点から、
ビジネスコンポーネント (BC) であるトランザクションを REST Web サービスとして構成したり、
データプロバイダーを REST Web サービスとして構成したり、
プロシージャーを REST Web サービスとして構成したりすることもできます。
必要な設定を行うことで、
API、
ビジネスコンポーネント、
データプロバイダー、
プロシージャーをカプセル化したデータを、HTTP プロトコルを使用して、REST サービスとして Web 経由で利用できます。
REST アプリケーションはプロシージャーベースのリモートアプリケーションとは異なるアプローチが要求されます。
REST では、焦点がリソースの広域性に置かれます。たとえば、REST アプリケーションは、製品、顧客、注文などのリソースを定義することができます。
したがって、このようなアプリケーションの設計プロセスは、各リソースを識別する必要があります。各リソースには固有の URI があることを覚えておいてください。
- 製品全体の URI と各製品の URI
- 注文全体の URI と各注文の URI
- その他
実装する必要があるメソッドを検討します。たとえば、エンドユーザーにプロシージャーのリストにアクセスさせる場合は GET、各製品にアクセスする場合は (GET)、注文書を追加する場合は (POST)、注文を更新する場合は (PUT) です。API を設計する際のその他の考慮事項については、
REST プロトコルに関する考慮事項を確認してください。
パラメーターのタイプも考慮する必要があります。GET と DELETE の動詞を使用する場合は、基本データタイプ (数値、文字列、日付、GUID などのスカラー型) を使用することをお勧めします。それらのデータタイプでは転送に URL queryString が使用されるためです。出力にはこの制限はありません。
GeneXus では、REST サービスは簡単に開発、使用できます。
REST サービスは、オブジェクトのプロパティを設定するだけで生成され、サービスのドキュメントは
自動的に生成されます。詳細は、この後の各記事を参照してください。
REST サービスの利用については (GeneXus で生成可能かどうかにかかわらず)、GeneXus は
OpenAPI インポートツールを提供します。