Skip to main content

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

 

 

OutSystems

REST APIを公開する

メソッドを公開して別のシステムが情報を取得または操作できるようにするには、REST APIを利用します。

REST APIサービスを作成する

  1. Logic]タブで、Integrationsフォルダを開きます。
  2. [REST]を右クリックし、[Expose REST API...]を選択します。
  3. REST APIの名前を設定します。
    一般的に、公開されるREST APIのバージョンに基づく名前を付けることを推奨します。たとえば、REST APIの最初のバージョンは、API v1という名前を付けることができます。PhoneBookなど、他の名前を使用することもできます。

REST APIメソッドを作成する

  1. REST APIを右クリックし、[Add REST API Method]を選択します。
  2. REST APIメソッドの名前を設定します。例: GetContactsCreateContactUpdateContact
  3. HTTP Methodプロパティを、メソッドが実行するアクションに対応するHTTP動詞に設定します。
    • GET - 読み取り
    • POST - 作成
    • PUT - 更新
    • DELETE - 削除
  4. 公開するデータを取得または操作するアクションとして、メソッドを設計します。
    例: GetContactsはすべてのContactsのリストを返し、CreateContactまたはUpdateContactは「Contact」レコードを受け取り、作成または更新された連絡先の「Id」を返します。

アプリケーションをデプロイすると、REST APIエンドポイントにアクセスできるようになります。

例:

デフォルトのエンドポイント 説明
GET https://<サーバー>/PhoneAPI/rest/v1/GetContacts 連絡先をすべて取得します。
GET https://<サーバー>/PhoneAPI/rest/v1/GetContact 連絡先を1つ取得します。
POST https://<サーバー>/PhoneAPI/rest/v1/CreateContact 連絡先を1つ作成します。
PUT https://<サーバー>/PhoneAPI/rest/v1/UpdateContact 連絡先を1つ更新します。
DELETE https://<サーバー>/PhoneAPI/rest/v1/DeleteContact 連絡先を1つ削除します。
GET https://<サーバー>/PhoneAPI/rest/v1/GetContactAddresses 連絡先の住所をすべて取得します。

デフォルトのエンドポイントは、HTTPメソッド(GETPOSTPUTDELETE)と、REST APIメソッドの名前に基づいて定義されますが、必要に応じてエンドポイントをカスタマイズできます。

curlPostmanなどの利用可能なツールを使用してREST APIメソッドをテストしたり、そのエフェクト用にOutSystemsアプリケーションを構築したりすることができます。

入力パラメータがRecord(POSTPUTなど)の操作メソッドの場合は、Content-Typeヘッダーの値をapplication/jsonにしてリクエストに追加する必要があります。

  • Was this article helpful?