Developer:Integration: Testing REST API using workbench.

So, you built a REST API integration, wrote a test class to validate your code and everything seems to be fine with the test results and code coverage.

How do you test your code and actually see it generate the desired output?

Solution

Workbench.developerforce.com is a tool that can be used to test your API's.
Log in to the desired environment.

Click on Utilities---REST explorer.

Select the method for which you have built your API. For our purpose I am going to assume it is a GET method that was written.

So, select the HTTP method as GET and in the URL:

after entering /services/apexrest/

enter the name of the RESTResource (url mapping) as defined in the global class.

Let's call it CheckReq. Your URL should now look as follows:

/services/apexrest/CheckReq

Say within the global API you have a class called CheckReqProcessing then your URL should finally look like:

/services/apexrest/CheckReq/CheckReqProcessing; hit execute.

Get Method does not require an input so you should see the results of your API.
Your class code would be looking something like:

@RestResource(urlMapping='/CheckReq/*')

global with sharing class CheckReqProcessing {

@HttpGet
<<<Define Actions>>>>

}

Test Class Code:

Your test class code would need to have the following amongst all the all the things that it needs to be successfull:

RestRequest req = new RestRequest();

        RestResponse res = new RestResponse();
        req.requestURI = '/services/apexrest/CheckReq';
        req.httpMethod = 'GET';
        RestContext.request = req;
        RestContext.response = res;
        
        List<ObjjectName> CR = CheckReqProcessing.getUnsentCR();