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動詞によって認識します。

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

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

特定のリソースを処理する場合、URLパスをコレクション名で開始し、HTTP動詞に応じて以下を追加します。

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

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

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

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