Community

REST URLをカスタマイズする

この記事は作成中です。この新しいバージョンはどの程度参考になりましたか。投票でお聞かせください。

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

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

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

GET https://<サーバー>/PhoneAPI/rest/v1/Contacts/{Id}

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

［Logic］タブで、Integrationsフォルダを開きます。
REST APIを展開し、変更するメソッドを選択してプロパティを表示します。
REST APIメソッドのURL Pathプロパティを新しいカスタムURLに設定します。

例: /Contacts/{Id}

注記: URLに含まれる入力パラメータを必須として設定する必要があります。

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

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

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

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

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

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

デフォルトのエンドポイント	URLパス	カスタマイズされたエンドポイント
`GET https://<サーバー>/PhoneAPI/rest/v1/GetContact`	`/Contacts/{Id}`	`GET https://<サーバー>/PhoneAPI/rest/v1/Contacts/{Id}`
`DELETE https://<サーバー>/PhoneAPI/rest/v1/DeleteContact`	`/Contacts/{Id}`	`DELETE https://<サーバー>/PhoneAPI/restv1/Contacts/{Id}`
`PUT https://<サーバー>/PhoneAPI/rest/v1/UpdateContact`	`/Contacts`	`PUT https://<サーバー>/PhoneAPI/rest/v1/Contacts`

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

デフォルトのエンドポイント	URLパス	カスタマイズされたエンドポイント
`GET https://<サーバー>/PhoneAPI/rest/v1/GetContactAddresses`	`/Contacts/{Id}/Addresses`	`GET https://<サーバー>/PhoneAPI/rest/v1/Contacts/{Id}/Addresses`