SPRemoteAPI VSCode Extension
New in version 1.5 Create TypeScript Interfaces
Select the SharePoint type and click the "Create Interface" options
Copy interfaces into your own Typescript file. Import and get intellisense and type checking.
Using SPRemoteAPI Extension (Step 1)
In VSCode just hit F1 and start typing SPRemoteAPI and you will see it appear in the drop down list.
Using SPRemoteAPI Extension (Step 2)
Using SPRemoteAPI Extension (Step 3)
Once you have selected the type, you are presented an information dialog showing you the type along with options for displaying properties and methods or creating a TypeScript interface. The options also shows you the number of each contained in the type.
Using SPRemoteAPI Extension (Step 4)
Select the methods options and you are presented a list of available methods to choose.
Using SPRemoteAPI Extension (Step 5)
Choose a method and then you are presented a new code window (virtual document) containing a JSON representation of all the method’s information needed to call it remotely using REST. It shows you the parameter types, required post body and response body. The post body can be copied into whatever REST calling framework you are using such as FETCH or JQuery. The response can be used to guide you in what to expect in the payload response from the call. This gives you ability to write remote REST calls without having to do all the extra experimentation to see what the call returns. Having both the body and response JSON templates will save you a lot of time searching on the internet.
What about properties?
Below is example of the code window you are given when you select properties. It shows you all the available properties for the type and the information you need to determine what is available remotely from SharePoint Office 365.
SPRemoteAPI in action
Supports SharePoint 2013
This also supports SharePoint 2013, just add the following to your user settings: