Now Postman is awesome, but I came across this really good rest-client plugin for VSCode.

What makes it so good is that I can save the .rest or .http files all in one place with my VSCode project and have them form part of my Git version tracking.

So when someone pulls my code they also get the sample REST commands.

One of our most notorious products requires SOAP calls. Now I can save a .http file that contains the syntax required.

POST http://{{host}}:{{port}}/lagan/services/FL HTTP/1.1
Content-Type: text/xml
SOAPAction: retrieveCaseDetails

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:flt="http://www.lagan.com/wsdl/FLTypes" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"&gt;
   <soapenv:Header&gt;
    <wsse:Security&gt;
    <!--
    	<wsse:BinarySecurityToken&gt;{{binary-token}}</wsse:BinarySecurityToken&gt;
    --&gt;
      <wsse:UsernameToken xmlns:wsse='http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd' &gt;
        <wsse:Username&gt;{{username}}</wsse:Username&gt;
        <wsse:Password Type='http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText'&gt;
           {{password}}
        </wsse:Password&gt;
      </wsse:UsernameToken&gt;
    </wsse:Security&gt;
   </soapenv:Header&gt;
   <soapenv:Body&gt;
      <flt:FWTCaseFullDetailsRequest&gt;
         <flt:CaseReference&gt;XXXXXXXXXX</flt:CaseReference&gt;
         <!--1 or more repetitions:--&gt;
         <Option&gt;all</Option&gt;<!-- all, core, eforms-r, eforms-rw, events, form, fullform, notes, tasks, workflow, interactions, eform-data --&gt;
      </flt:FWTCaseFullDetailsRequest&gt;
	</soapenv:Body&gt;
</soapenv:Envelope&gt;

CMD+SHIFT+R then runs my REST file and returns the response in a new tab/window.

Notice the same style of double {{moustache}} usage for Environment variables as Postman. I can edit my settings.json file and add in the environments I need.

    "rest-client.environmentVariables": {
        "$shared": {
            "port": "8080"
        },
        "testserver": {
            "host": "testserver",
            "username": "mytestuser",
            "password": "mysecret"
        },
        "liveserver": {
            "host": "liveserver",
            "username": "myrealuser",
            "password": "mysecret"
        },
    }

I can then switch environments (down in the bottom right) without modifying my .http file. This also ensures that whilst the variables are used in my files I am not including any passwords with my Git, so no data leakage.

Advertisements