Apex 開発者ガイド
jRestResource アノテーション
@RestResource アノテーションはクラスレベルで使用され、Apex クラスを REST リソースとして公開できるようにします。
このアノテーションを使用する場合、次の点に留意してください。
- URL 対応付けは、https://instance.salesforce.com/services/apexrest/ と相対的です。
- URL 対応付けにはワイルドカード (*) を含めることができます。
- URL の対応付けでは、大文字と小文字は区別されます。たとえば、my_url の URL 対応付けは、My_Url ではなく、my_url を含む REST リソースに一致します。
- このアノテーションを使用するには、Apex クラスがグローバルとして定義されている必要があります。
URL のガイドライン
URL パスの対応付けは次のようになります。
- パスはスラッシュ (/) で開始する必要があります。
- パスの文字数は、最大 255 文字です。
- ワイルドカード (*) をパスで使用するときは、ワイルドカードの前にスラッシュ (/) を付ける必要があります。また、ワイルドカードがパスの最後の文字でない場合は、ワイルドカードの後にもスラッシュ (/) を付ける必要があります。
URL 対応付けのルールは次のようになります。
- 常に完全一致が優先されます。
- 完全一致がない場合、ワイルドカードを使用して一致するすべてのパターンを検索し、そのうち文字列の長さが最も長いものが選択されます。
- ワイルドカード一致が見つからない場合、HTTP 応答状況コード 404 が返されます。
名前空間にあるクラスの URL には名前空間が含まれます。たとえば、クラスが名前空間 abc 内にあり、クラスが your_url に対応付けられている場合、API URL は https://instance.salesforce.com/services/apexrest/abc/your_url/ のように変更されます。URL が競合する場合、名前空間にあるクラスが常に使用されます。