Salesforce RestResourceとは？ SalesforceのRestResourceとは、Salesforceで用意されているApexアノテーションの一つです。 SalesforceのApexアノテーションとは、メソッドやクラスの使用方法を変更するもので、宣言する際は@記号を付けて記述します。メソッドにApexアノテーションを宣言する場合は、メソッド定義やクラス定義の直前に記述します。 以下はApexアノテーションの一つである「Futureアノテーション」（@future）の宣言例です。対象のメソッドの直前に宣言します。Futureアノテーションはメソッドを非同期で実行させる場合に使用します。

global class MyClass {
     @future
     Public static void myMethod(String a)
     {
          //long-running Apex code
     }
}

RestResourceアノテーション

RestResourceアノテーションの留意点

URLパスのルール

RestResourceサンプルコード（1）

@RestResource(urlMapping='/Account/*')
global with sharing class MyRestResource {

    @HttpDelete
    global static void doDelete() {
        RestRequest req = RestContext.request;
        RestResponse res = RestContext.response;
        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1);
        Account account = [SELECT Id FROM Account WHERE Id = :accountId];
        delete account;
    }

    @HttpGet
    global static Account doGet() {
        RestRequest req = RestContext.request;
        RestResponse res = RestContext.response;
        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1);
        Account result = [SELECT Id, Name, Phone, Website FROM Account WHERE Id = :accountId];
        return result;
    }

    @HttpPost
    global static String doPost(String name,
        String phone, String website) {
        Account account = new Account();
        account.Name = name;
        account.phone = phone;
        account.website = website;
        insert account;
        return account.Id;
    }
}

サンプルコードの説明

doGetメソッドのコール

curl -H "Authorization: Bearer sessionId"
"https://instance.salesforce.com/services/apexrest/Account/accountId"

{
  "attributes" :
    {
      "type" : "Account",
      "url" : "/services/data/v22.0/sobjects/Account/accountId"
    },
  "Id" : "accountId",
  "Name" : "Acme"
}

RestResourceサンプルコード（2）

@RestResource(urlMapping='/SayGoodbye/*')
global with sharing class SayGoodbyeApi {

    @HttpGet
    global static String doGet() {
        RestRequest req = RestContext.request;
        String name = req.params.get('name');
        return 'Goodbye ' + name;
    }

    @HttpPost
    global static String doPost(String name) {
        return 'Goodbye ' + name;
    }
}

サンプルコードのテストプログラム

@isTest
private class SayGoodbyeApiTest {

    /*** Postの確認を行う ***/
    private static testMethod void doPostTest() {
        String result;
        Test.startTest();
        result = SayGoodbyeApi.doPost('MyName');
        Test.stopTest();
        system.assertEquals(result, 'Goodbye MyName');
    }

    /*** Getの確認を行う ***/
    private static testMethod void doGetTest() {
        String result;
        RestRequest req;
        RestResponse res;

        // リクエストの作成
        req = new RestRequest();
        req.httpMethod = 'GET';
        req.requestURI = '/services/apexrequest/SayGoodbye/?name=MyName';

        // レスポンスの作成
        res = new RestResponse();

        // コンテキストの設定
        RestContext.request = req;
        RestContext.response = res;
        Test.startTest();
        result = SayGoodbyeApi.doGet();
        Test.stopTest();
        system.assertEquals(result, 'Goodbye MyName');
    }
}

RestResource 外部からの呼び出し

SalesforceのRestResourceを活用しよう！

この記事の監修者・著者

株式会社オープンアップITエンジニアAWSパートナー/Salesforce認定コンサルティングパートナー 認定企業

ITエンジニア派遣サービス事業を行っています。AWSやSalesforceなど専門領域に特化したITエンジニアが4,715名在籍し、常時100名以上のITエンジニアの即日派遣が可能です。

・2021年：AWS Japan Certification Award 2020 ライジングスター of the Year 受賞
・2022年3月：人材サービス型 AWSパートナー認定
・AWS認定資格保有者数1,154名（2024年6月現在）
・Salesforce認定コンサルティングパートナー
・Salesforce認定資格者276名在籍（2024年5月現在）
・LPIC＋CCNA 認定資格者：472 名（2024年6月時点）

最新の投稿

• 2024-12-27営業インタビュー情報共有の活性化の中心に。SP企画部の新たな取り組み
• 2024-07-01営業インタビュー最短で当日にご提案可能。 OPE営業の対応が早い3つの理由
• 2024-07-01営業インタビュー研修見学ツアーが高評価！「お客様のOPEに対する期待を高め、継続に貢献できればと思います。」
• 2024-07-01営業インタビュー信頼関係を構築し、エンジニアの長期就業へ