Skip to main content

 

拡張および連携

 

 

OutSystems

REST URLをカスタマイズする

OutSystemsでは、必要に応じてREST APIメソッドのURLをカスタマイズできます。
たとえば、次のURLがあるとします。

GET https://<サーバー>/MyAPI/rest/PhoneBook/GetContact?Id={Id}

これを次のようにカスタマイズできます。

GET https://<サーバー>/MyAPI/rest/PhoneBook/Contacts/{Id}

これには、以下の手順を実行します。

  1. Logic]タブで、Integrationsフォルダを開きます。
  2. REST APIを展開し、変更するメソッドを選択してプロパティを表示します。
  3. REST APIメソッドのURL Pathプロパティを新しいカスタムURLに設定します。
    例: /Contacts/{Id}.

これに従ってURLプロパティが変更されます。

以下のセクションでは、エンドポイントをカスタマイズする方法の例をいくつか示しています。

コレクションのエンドポイントの例

リソースに関連するメソッドには同じ名前を使用します。OutSystemsは、どのメソッドを実行するかをHTTP動詞(GETPOSTなど)によって認識します。

デフォルトのエンドポイント URLパス カスタマイズされたエンドポイント
GET https://<サーバー>/MyAPI/rest/PhoneBook/GetContacts /Contacts GET https://<サーバー>/MyAPI/rest/PhoneBook/Contacts
POST https://<サーバー>/MyAPI/rest/PhoneBook/CreateContact /Contacts POST https://<サーバー>/MyAPI/rest/PhoneBook/Contacts

リソースのエンドポイントの例

特定のリソースを処理する場合、「URL Path」プロパティの値をコレクション名で開始し、HTTP動詞に応じて以下のいずれかを追加します。

  • GETまたはDELETEの場合: {}の間にリソース識別子(REST APIメソッドの入力パラメータ)を追加します。
  • PUTの場合:リソースはすでにリクエストのヘッダーまたはボディで渡されているため、何も追加しません。
デフォルトのエンドポイント URLパス カスタマイズされたエンドポイント
GET https://<サーバー>/MyAPI/rest/PhoneBook/GetContact /Contacts/{Id} GET https://<サーバー>/MyAPI/rest/PhoneBook/Contacts/{Id}
DELETE https://<サーバー>/MyAPI/rest/PhoneBook/DeleteContact /Contacts/{Id} DELETE https://<サーバー>/MyAPI/rest/PhoneBook/Contacts/{Id}
PUT https://<サーバー>/MyAPI/rest/PhoneBook/UpdateContact /Contacts PUT https://<サーバー>/MyAPI/rest/PhoneBook/Contacts

サブコレクションのエンドポイントの例

マスター/詳細の関係の場合、詳細をマスターリソースのコレクションとして扱います。

デフォルトのエンドポイント URLパス カスタマイズされたエンドポイント
GET https://<サーバー>/MyAPI/rest/PhoneBook/GetContactAddresses /Contacts/{Id}/Addresses GET https://<サーバー>/MyAPI/rest/PhoneBook/Contacts/{Id}/Addresses
  • Was this article helpful?