分类： Salesforce-API

我们建议您也考虑对API端点进行版本控制，以便在不破坏现有代码的情况下提供功能升级。您可以创建两个指定 /Cases/v1/*和/Cases/v2/* 的URL映射的类来实现此功能。

让我们开始创建一个Apex REST类。

1. 从设置档（打开设备齿轮图标）打开开发者控制台。
2. 在开发者控制台中，选择 File | New | Apex Class.
3. 对于课程名称，输入CaseManager，然后单击 OK.
4. 将自动生成的代码替换为以下类定义。

   @RestResource(urlMapping='/Cases/*')
   global with sharing class CaseManager {
   
       @HttpGet
       global static Case getCaseById() {
           RestRequest request = RestContext.request;
           // 从URL的末尾抓取caseId
           String caseId = request.requestURI.substring(
             request.requestURI.lastIndexOf('/')+1);
           Case result =  [SELECT CaseNumber,Subject,Status,Origin,Priority
                           FROM Case
                           WHERE Id = :caseId];
           return result;
       }
   
       @HttpPost
       global static ID createCase(String subject, String status,
           String origin, String priority) {
           Case thisCase = new Case(
               Subject=subject,
               Status=status,
               Origin=origin,
               Priority=priority);
           insert thisCase;
           return thisCase.Id;
       }   
   
       @HttpDelete
       global static void deleteCase() {
           RestRequest request = RestContext.request;
           String caseId = request.requestURI.substring(
               request.requestURI.lastIndexOf('/')+1);
           Case thisCase = [SELECT Id FROM Case WHERE Id = :caseId];
           delete thisCase;
       }     
   
       @HttpPut
       global static ID upsertCase(String subject, String status,
           String origin, String priority, String id) {
           Case thisCase = new Case(
                   Id=id,
                   Subject=subject,
                   Status=status,
                   Origin=origin,
                   Priority=priority);
           // 通过Case Id匹配，如果存在的话。
           // 否则，创建新的案例。
           upsert thisCase;
           // 返回案例ID。
           return thisCase.Id;
       }
   
       @HttpPatch
       global static ID updateCaseFields() {
           RestRequest request = RestContext.request;
           String caseId = request.requestURI.substring(
               request.requestURI.lastIndexOf('/')+1);
           Case thisCase = [SELECT Id FROM Case WHERE Id = :caseId];
           // 将JSON字符串反序列化为名称 - 值对
           Map<String, Object> params = (Map<String, Object>)JSON.deserializeUntyped(request.requestbody.tostring());
           // 遍历每个参数字段和值
           for(String fieldName : params.keySet()) {
               // 设置Case sObject的字段和值
               thisCase.put(fieldName, params.get(fieldName));
           }
           update thisCase;
           return thisCase.Id;
       }    
   
   }

5. 按下CTRL + S保存。

使用cURL检索数据

curl -v https://login.salesforce.com/services/oauth2/token -d "grant_type=password" -d "client_id=<your_consumer_key>" -d "client_secret=<your_consumer_secret>" -d "username=<your_username>" -d "password=<your_password_and_security_token>" -H 'X-PrettyPrint:1'

curl https://yourInstance.salesforce.com/services/apexrest/Cases/<Record_ID> -H 'Authorization: Bearer <your_session_id>' -H 'X-PrettyPrint:1'

从WSDL生成一个Apex类

1. 从“设置”中，在“快速查找”框中输入“Apex类”，然后单击 Apex Classes.
2. 点击 Generate from WSDL.
3. 点击 Choose File 然后选择下载的calculator.xml文件。
4. 点击 Parse WSDL. 应用程序为WSDL文档中的每个名称空间生成默认的类名称，并报告任何错误。

   对于这个例子，使用默认的类名称。但是，在现实生活中，强烈建议您更改默认名称，以使其更易于使用，并使代码更直观。

   现在该坦诚地谈谈WSDL解析器了。 WSDL2Apex解析是一个臭名昭着的善变。解析过程可能由于多种原因而失败，例如不支持的类型，多个绑定或未知元素。不幸的是，您可能会被迫手动编写调用Web服务的Apex类或使用HTTP。

5. 点击 Generate Apex code. 向导的最后一页显示生成的类以及任何错误。该页面还提供链接以查看成功生成的代码。
   生成的Apex类包括用于调用由WSDL文档表示的第三方Web服务的存根类和类类。这些类允许您从Apex调用外部Web服务。对于每个生成的类，使用相同的名称和前缀Async创建第二个类。 calculatorServices类用于同步标注。 AsyncCalculatorServices类用于异步标注。

执行标注

先决条件

在运行此示例之前，请使用“授权端点地址”部分中的步骤来授权Web服务标注的端点URL https://th-apex-soap-service.herokuapp.com

现在你可以执行标注，看看它是否正确添加两个数字。有一个计算器，方便检查结果。

1. 从设置档（打开设备齿轮图标）打开开发者控制台。
2. 在开发者控制台中，选择 Debug | Open Execute Anonymous Window.
3. 删除所有现有的代码，并插入下面的代码片段。

   calculatorServices.CalculatorImplPort calculator = new  calculatorServices.CalculatorImplPort();
   Double x = 1.0;
   Double y = 2.0;
   Double result = calculator.doAdd(x,y);
   System.debug(result);

4. 选择 Open Log, 然后单击 Execute.
5. 调试日志打开后，单击调试只查看System.debug语句的输出。日志应该显示3.0。

为标注指定模拟响应

当您从WSDL创建Apex类时，自动生成的类中的方法调用WebServiceCallout.invoke，该方法执行对外部服务的调用。在测试这些方法时，只要调用WebServiceCallout.invoke，就可以指示Apex运行时生成一个假响应。为此，请实现WebServiceMock接口并指定测试运行时发送的假响应。

指示Apex运行时通过在您的测试方法中调用Test.setMock来发送此假响应。对于第一个参数，传递WebServiceMock.class。对于第二个参数，传递一个WebServiceMock接口实现的新实例。

Test.setMock(WebServiceMock.class, new MyWebServiceMockImpl());

1. 在开发者控制台中，选择 File | New | Apex Class.
2. 对于类名称，输入AwesomeCalculator，然后单击 OK.
3. 用下面的类定义替换自动生成的代码。

   public class AwesomeCalculator {
       public static Double add(Double x, Double y) {
           calculatorServices.CalculatorImplPort calculator = 
               new calculatorServices.CalculatorImplPort();
           return calculator.doAdd(x,y);
       }
   }

4. 按下CTRL + S保存。

   在测试过程中创建您的模拟实现来伪造标注。您的WebServiceMock实现调用doInvoke方法，该方法返回您为测试指定的响应。这些代码大部分是样板。这个练习中最难的部分就是搞清楚Web服务如何返回一个响应，这样你就可以伪造一个值。

5. 在开发者控制台中，选择 File | New | Apex Class.
6. 对于类名称，输入CalculatorCalloutMock，然后单击 OK.
7. 将自动生成的代码替换为以下类定义。

   @isTest
   global class CalculatorCalloutMock implements WebServiceMock {
      global void doInvoke(
              Object stub,
              Object request,
              Map<String, Object> response,
              String endpoint,
              String soapAction,
              String requestName,
              String responseNS,
              String responseName,
              String responseType) {
           // 开始 - 指定你想发送的响应
           calculatorServices.doAddResponse response_x = 
               new calculatorServices.doAddResponse();
           response_x.return_x = 3.0;
           // 结束
           response.put('response_x', response_x); 
      }
   }

8. 按下CTRL + S保存。

   最后，您的测试方法需要通过调用Test.setMock来指示Apex运行时发送假响应，然后在AwesomeCalculator类中进行标注。像任何其他测试方法一样，我们断言我们的模拟响应得到了正确的结果。

9. 在开发者控制台中，选择 File | New | Apex Class.
10. 对于类名称，输入AwesomeCalculatorTest，然后单击 OK.
11. 将自动生成的代码替换为以下类定义。

    @isTest
    private class AwesomeCalculatorTest {
        @isTest static void testCallout() {              
            // 这将导致生成一个假的响应
            Test.setMock(WebServiceMock.class, new CalculatorCalloutMock());
            // 调用调用标注的方法
            Double x = 1.0;
            Double y = 2.0;
            Double result = AwesomeCalculator.add(x, y);
            // 验证是否返回假结果
            System.assertEquals(3.0, result); 
        }
    }

12. 按下CTRL + S保存。
13. 要运行测试，请选择 Test | Run All.

AwesomeCalculator类现在应该显示100％的代码覆盖率！

先决条件

在编写测试之前，让我们创建一个类，其中包含我们在“将数据发送到服务”单元中匿名执行的GET和POST请求示例。这些示例稍有修改，以便请求在方法和返回值中，但它们与前面的示例基本相同。

使用StaticResourceCalloutMock测试标注

要测试您的标注，请通过实现接口或使用静态资源来使用模拟标注。在这个例子中，我们稍后使用静态资源和模拟接口。静态资源包含要返回的响应主体。同样，使用模拟标注时，请求不会发送到端点。相反，Apex运行时知道查找在静态资源中指定的响应，并返回它。 Test.setMock方法通知运行时在测试方法中使用模拟标注。让我们看看模拟标注在行动。首先，我们创建一个包含JSON格式字符串的静态资源，用于GET请求。

1. 在开发者控制台中，选择 File | New | Static Resource.
2. 对于名称，输入GetAnimalResource。
3. 对于MIME类型，即使我们使用JSON，也请选择text / plain。
4. 点击 Submit.
5. 在为资源打开的选项卡中，插入以下内容。确保它全部在一行上，不会中断到下一行。这个内容是模拟标注返回的内容。这是三个林地生物阵列。

   {"animals": ["pesky porcupine", "hungry hippo", "squeaky squirrel"]}

6. 按下CTRL + S保存。

您已成功创建您的静态资源！现在，让我们为使用此资源的标注添加一个测试。

1. 在开发者控制台中，选择 File | New | Apex Class.
2. 对于类名称，输入AnimalsCalloutsTest，然后单击 OK.
3. 将自动生成的代码替换为以下测试类定义。

   @isTest
   private class AnimalsCalloutsTest {
   
       @isTest static  void testGetCallout() {
           // 基于静态资源创建模拟响应
           StaticResourceCalloutMock mock = new StaticResourceCalloutMock();
           mock.setStaticResource('GetAnimalResource');
           mock.setStatusCode(200);
           mock.setHeader('Content-Type', 'application/json;charset=UTF-8');
           // 将标注与模拟响应相关联
           Test.setMock(HttpCalloutMock.class, mock);
           // 调用方法来测试
           HttpResponse result = AnimalsCallouts.makeGetCallout();
           // 验证模拟响应不为空
           System.assertNotEquals(null,result,
               'The callout returned a null response.');
           // 验证状态码
           System.assertEquals(200,result.getStatusCode(),
             'The status code is not 200.');
           // 验证内容类型
           System.assertEquals('application/json;charset=UTF-8',
             result.getHeader('Content-Type'),
             'The content type value is not expected.');  
           // 验证数组包含3个项目 
           Map<String, Object> results = (Map<String, Object>) 
               JSON.deserializeUntyped(result.getBody());
           List<Object> animals = (List<Object>) results.get('animals');
           System.assertEquals(3, animals.size(),
             'The array should only contain 3 items.');          
       }   
   
   }

4. 按下CTRL + S保存。
5. 选择 Test | Always Run Asynchronously.如果不选择“始终运行异步”，则测试运行只包含一个同步运行的类。您只能从“测试”选项卡打开日志，以进行同步测试运行。
6. 要运行测试，请选择 Test | New Run.
7. 从Test Classes列表中选择 AnimalsCalloutsTest.
8. 点击 Add Selected | Run.

测试结果显示在测试运行ID下的测试选项卡中。测试执行完成后，展开测试运行以查看详细信息。现在在“代码总体覆盖率”窗格中双击AnimalCallouts，查看测试覆盖了哪些行。

用HttpCalloutMock测试标注

为了测试你的POST标注，我们提供了一个HttpCalloutMock接口的实现。此接口使您能够指定在响应方法中发送的响应。您的测试类指示Apex运行时通过再次调用Test.setMock来发送此假响应。对于第一个参数，传递HttpCalloutMock.class。对于第二个参数，传递一个AnimalsHttpCalloutMock的新实例，它是您的HttpCalloutMock的接口实现。 （在这个例子之后的例子中，我们将写AnimalsHttpCalloutMock）

Test.setMock(HttpCalloutMock.class, new AnimalsHttpCalloutMock());

1. 在开发者控制台中，选择 File | New | Apex Class.
2. 对于类名，输入AnimalsHttpCalloutMock，然后单击 OK.
3. 将自动生成的代码替换为以下类定义。

   @isTest
   global class AnimalsHttpCalloutMock implements HttpCalloutMock {
       // 实现这个接口方法
       global HTTPResponse respond(HTTPRequest request) {
           // 创建一个假的回应
           HttpResponse response = new HttpResponse();
           response.setHeader('Content-Type', 'application/json');
           response.setBody('{"animals": ["majestic badger", "fluffy bunny", "scary bear", "chicken", "mighty moose"]}');
           response.setStatusCode(200);
           return response; 
       }
   }

4. 按下CTRL + S保存。

在您的测试类中，创建testPostCallout方法来设置模拟标注，如下例所示。 testPostCallout方法调用Test.setMock，然后调用AnimalsCallouts类中的makePostCallout方法。然后验证返回的响应是您在模拟实现的响应方法中指定的。

1. 修改测试类AnimalsCalloutsTest添加第二个测试方法。单击类选项卡，然后在右括号之前添加以下方法。

   @isTest static void testPostCallout() {
       // 设置模拟标注类
       Test.setMock(HttpCalloutMock.class, new AnimalsHttpCalloutMock()); 
       //这会导致从实现HttpCalloutMock的类发送假响应。 
       HttpResponse response = AnimalsCallouts.makePostCallout();
       // Verify that the response received contains fake values
       String contentType = response.getHeader('Content-Type');
       System.assert(contentType == 'application/json');
       String actualValue = response.getBody();
       System.debug(response.getBody());
       String expectedValue = '{"animals": ["majestic badger", "fluffy bunny", "scary bear", "chicken", "mighty moose"]}';
       System.assertEquals(actualValue, expectedValue);
       System.assertEquals(200, response.getStatusCode());
   }

2. 按下CTRL + S保存。
3. 选择 Test | New Run.
4. 从Test Classes列表中选择 AnimalsCalloutsTest.
5. 点击 Add Selected | Run.

   测试结果显示在“测试”选项卡下的新测试运行ID下。当测试执行完成时，展开测试运行以查看有关这两个测试的详细信息。

何时使用REST API

REST API提供了一个强大，方便，简单的基于REST的Web服务接口，用于与Salesforce进行交互。它的优点包括易于集成和开发，并且是移动应用程序和Web项目使用的最佳技术选择。但是，如果您有多个要处理的记录，请考虑使用Bulk API，该API基于REST原则并针对大量数据集进行了优化。

何时使用SOAP API

SOAP API为与Salesforce进行交互提供了一个强大，方便且简单的基于SOAP的Web服务界面。您可以使用SOAP API创建，检索，更新或删除记录。您还可以使用SOAP API执行搜索等等。使用任何支持Web服务的语言使用SOAP API。

例如，您可以使用SOAP API将Salesforce与您的组织的ERP和财务系统集成。您还可以向公司门户网站提供实时销售和支持信息，并使用客户信息填充关键业务系统。

何时使用Chatter REST API

使用Chatter REST API来显示Salesforce数据，尤其是在移动应用程序中。除Chatter提要，用户，组和追随者外，Chatter REST API还提供对文件，推荐，主题，通知，Data.com采购等的编程式访问。 Chatter REST API类似于其他公司提供的API，例如Facebook和Twitter，但也暴露了Chatter之外的Salesforce功能。

何时使用Analytics REST API

您可以使用Google Analytics REST API以编程方式访问Google Analytics资产（如数据集，镜头和仪表板）。将查询直接发送到Analytics平台。访问已导入到Google Analytics平台的数据集。创建和检索镜头。访问XMD信息。检索数据集版本的列表。创建和检索分析应用程序。创建，更新和检索Google Analytics仪表板。检索应用程序的依赖关系列表。确定哪些功能可供用户使用。使用快照。操作复制的数据集。

何时使用批量API

批量API基于REST原则，并针对加载或删除大量数据进行了优化。您可以使用它通过提交批来异步查询，查询所有，插入，更新，插入或删除许多记录。 Salesforce在后台处理批次。

相比之下，SOAP API针对实时客户端应用程序进行了优化，每次更新一些记录。您可以使用SOAP API来处理许多记录，但是当数据集包含数十万条记录时，SOAP API不太实用。批量API旨在使处理从数千条到数百万条记录的数据变得简单。

使用Bulk API最简单的方法是使用CSV文件在Data Loader中处理记录。使用Data Loader可以避免编写自己的客户端应用程序。

何时使用元数据API

使用元数据API检索，部署，创建，更新或删除您的组织的自定义项。最常见的用法是将更改从沙箱或测试组织迁移到生产环境。元数据API旨在用于管理自定义和用于构建可以管理元数据模型的工具，而不是数据本身。

何时使用流式API

使用Streaming API接收与您定义的SOQL查询匹配的数据更改的通知。

如果要将通知从服务器推送到客户端，则Streaming API非常有用。考虑经常轮询的应用程序的流API。持续轮询Salesforce基础设施的应用程序会消耗不必要的API调用和处理时间。 Streaming API减少了不返回数据的请求的数量，对于需要数据更改的一般通知的应用程序也非常理想。

流式API使您可以减少API调用的数量并提高性能。

何时使用Apex REST API

如果要公开Apex类和方法，请使用Apex REST API，以便外部应用程序可以通过REST体系结构访问您的代码。 Apex REST API支持OAuth 2.0和会话ID进行授权。

何时使用Apex SOAP API

如果要将Apex方法公开为SOAP Web服务API，请使用Apex SOAP API，以便外部应用程序可以通过SOAP访问您的代码。

Apex SOAP API支持OAuth 2.0和会话ID进行授权。

何时使用工具API

使用工具API将Salesforce元数据与其他系统集成。元数据类型公开为sObjects，因此您可以访问复杂类型的一个组件。这个字段级访问加快了对复杂元数据类型的操作。您还可以为Force.com应用程序构建自定义开发工具。例如，使用工具API来管理和部署Apex类和触发器以及Visualforce页面和组件的工作副本。您还可以设置检查点或堆转储标记，执行匿名Apex，并访问日志记录和代码覆盖率信息。

REST和SOAP都支持。

先决条件

在编写测试之前，让我们创建一个类，其中包含我们在“将数据发送到服务”单元中匿名执行的GET和POST请求示例。这些示例稍有修改，以便请求在方法和返回值中，但它们与前面的示例基本相同。

使用StaticResourceCalloutMock测试外呼

要测试您的标注，请通过实现接口或使用静态资源来使用模拟标注。在这个例子中，我们稍后使用静态资源和模拟接口。静态资源包含要返回的响应主体。同样，使用模拟标注时，请求不会发送到端点。相反，Apex运行时知道查找在静态资源中指定的响应，并返回它。 Test.setMock方法通知运行时在测试方法中使用模拟标注。让我们看看模拟标注在行动。首先，我们创建一个包含JSON格式字符串的静态资源，用于GET请求。

1. 在开发者控制台中，选择 File | New | Static Resource.
2. 对于名称，输入GetAnimalResource.
3. 对于MIME类型，选择text/plain, 即使使用JSON.
4. 点击Submit.
5. 在为资源打开的选项卡中，插入以下内容。确保它全部在一行上，不会中断到下一行。这个内容就是模拟标注返回的内容。这是三个林地生物阵列。
   {“animals”: [“pesky porcupine”, “hungry hippo”, “squeaky squirrel”]}
6. 点击CTRL+S保存.

您已成功创建您的静态资源！现在，让我们为使用此资源的标注添加一个测试。

1. 在开发者控制台中，选择 File | New | Apex Class.
2. 对于类名称，输入 AnimalsCalloutsTest 然后单击OK.
3. 将自动生成的代码替换为以下测试类定义。

   @isTest
   private class AnimalsCalloutsTest {

   @isTest static void testGetCallout() {
   // 基于静态资源创建模拟响应
   StaticResourceCalloutMock mock = new StaticResourceCalloutMock();
   mock.setStaticResource(‘GetAnimalResource’);
   mock.setStatusCode(200);
   mock.setHeader(‘Content-Type’, ‘application/json;charset=UTF-8’);
   // 外呼与模拟响应相关联
   Test.setMock(HttpCalloutMock.class, mock);
   // 调用方法来测试
   HttpResponse result = AnimalsCallouts.makeGetCallout();
   // 验证模拟响应不为空
   System.assertNotEquals(null,result,
   ‘标注返回了一个空响应。’);
   // 验证状态码
   System.assertEquals(200,result.getStatusCode(),
   ‘状态码不是200.’);
   // 验证内容类型
   System.assertEquals(‘application/json;charset=UTF-8’,
   result.getHeader(‘Content-Type’),
   ‘The content type value is not expected.’);
   // 验证数组包含3个项目
   Map<String, Object> results = (Map<String, Object>)
   JSON.deserializeUntyped(result.getBody());
   List<Object> animals = (List<Object>) results.get(‘animals’);
   System.assertEquals(3, animals.size(),
   ‘数组只应该包含3个项目’);
   }

   }
4. 点击CTRL+S 保存.
5. 选择 Test | Always Run Asynchronously. 如果不选择“始终运行异步”，则测试运行只包含一个同步运行的类。您只能从“测试”选项卡打开日志，以进行同步测试运行。
   要运行测试，请选择Test | New Run.
6. 从Test Classes列表中选择 AnimalsCalloutsTest.
7. 点击Add Selected | Run.

测试结果显示在测试运行ID下的测试选项卡中。测试执行完成后，展开测试运行以查看详细信息。现在在“代码总体覆盖率”窗格中双击AnimalCallouts，查看测试覆盖了哪些行。

使用HttpCalloutMock测试外呼

为了测试你的POST标注，我们提供了一个HttpCalloutMock接口的实现。此接口使您能够指定在响应方法中发送的响应。您的测试类指示Apex运行时通过再次调用Test.setMock发送此假响应。对于第一个参数，传递HttpCalloutMock.class。对于第二个参数，传递一个AnimalsHttpCalloutMock的新实例，它是您的HttpCalloutMock的接口实现。 （在这个例子之后的例子中，我们将写AnimalsHttpCalloutMock）

现在添加实现HttpCalloutMock接口的类来拦截标注。如果在测试上下文中调用HTTP标注，则不会进行标注。相反，您会收到您在AnimalsHttpCalloutMock中的响应方法实现中指定的模拟响应。

1. 在开发者控制台中，选择 File | New | Apex Class.
2. 对于类名，输入 AnimalsHttpCalloutMock然后单击OK.
3. 自动生成的代码替换为以下类定义。
   @isTest
   global class AnimalsHttpCalloutMock implements HttpCalloutMock {
   // 实现这个接口方法
   global HTTPResponse respond(HTTPRequest request) {
   // 创建一个假的回应
   HttpResponse response = new HttpResponse();
   response.setHeader(‘Content-Type’, ‘application/json’);
   response.setBody(‘{“animals”: [“majestic badger”, “fluffy bunny”, “scary bear”, “chicken”, “mighty moose”]}’);
   response.setStatusCode(200);
   return response;
   }
   }
4. 点击CTRL+S保存.

在您的测试类中，创建testPostCallout方法来设置模拟标注，如下例所示。 testPostCallout方法调用Test.setMock，然后调用AnimalsCallouts类中的makePostCallout方法。然后验证返回的响应是您在模拟实现的响应方法中指定的。

1. 修改测试类AnimalsCalloutsTest添加第二个测试方法。单击类选项卡，然后在右括号之前添加以下方法。
   @isTest static void testPostCallout() {
   // 设置模拟外呼类
   Test.setMock(HttpCalloutMock.class, new AnimalsHttpCalloutMock());
   //这会导致一个假的响应被发送
   // 从实现HttpCalloutMock的类中
   HttpResponse response = AnimalsCallouts.makePostCallout();
   //验证收到的响应是否包含假值
   String contentType = response.getHeader(‘Content-Type’);
   System.assert(contentType == ‘application/json’);
   String actualValue = response.getBody();
   System.debug(response.getBody());
   String expectedValue = ‘{“animals”: [“majestic badger”, “fluffy bunny”, “scary bear”, “chicken”, “mighty moose”]}’;
   System.assertEquals(actualValue, expectedValue);
   System.assertEquals(200, response.getStatusCode());
   }
2. 点击CTRL+S 保存.
3. 选择 Test | New Run.
4. 从Test Classes列表中选择AnimalsCalloutsTest.
5. 点击 Add Selected | Run.

   测试结果显示在“测试”选项卡下的新测试运行ID下。当测试执行完成时，展开测试运行以查看有关这两个测试的详细信息。