The SharePoint REST Framework was designed for SharePoint 2013, but works in both SharePoint 2013/Online (Classic/Modern) pages. This framework is designed to remove the overhead required for SharePoint development, allowing the developer to focus on the client requirements.
References
- gd-sprest - An easy way to execute requests against the SharePoint 2013/Online REST api
- gd-sprest-bs - Extends the Bootstrap Framework with components designed for SharePoint 2013/Online.
- gd-sprest-def - Generates TypeScript definition files from the $metadata SharePoint REST endpoint, for this library.
- gd-sprest-react - Extends the Office Fabric React Framework with components designed for SharePoint 2013/Online.
Core Library
The gd-sprest library is similar to the pnp-js-core, with the main difference being the ability to be used within the browser console window. This feature provides a “Powershell-Like” experience within the browser console window. This feature was designed for developers working in restricted SharePoint environments, or do not have access to the server or powershell access. Some additional benefits of the library are listed below:
- Designed to work in restricted SharePoint environments with limited access to the SharePoint Farm, Web App, Site Collection, Root Web, etc
- Helper functions designed to help create solutions in restricted SharePoint environments
- Ability to create reusable scripts/solutions
- Intellisense is available for JavaScript/TypeScript
- Ability to execute live requests from the browser console, helps to debug issues in production
Bugs/Issues
Click Here to report any bugs, request any new features or if need help with code examples. Pull requests are welcomed for anyone interested in submitting them. Feel free to email for other questions.
Intellisense
The SharePoint REST API has a $metadata endpoint which contains the intellisense for its objects. This library’s intellisense is generated from this data to ensure the latest functions/methods are made available for OnPremise and Online.
The intellisense for this library is included as part of the npm installation. It supports both JavaScript and TypeScript. The nuget installation includes the bundled definition file as part of the library.
Modern Experience in SharePoint 2013
One of the key reasons of creating this library, was to give an easy way to develop using the modern web stack in SharePoint 2013 environments.
User Adoption
Since these components are designed using same framework creating the new Office 365 modern experience, this gives the ability to introduce the new Office 365 experience within SharePoint 2013. This will be an important part for the SharePoint 2013 user adoption to the new modern experience. Most SharePoint 2010/2013 environments are undergoing upgrades to 2016, Hybrid 2016/O365, O365 and private O365-Gov environments.
Server-Side to Client-Side Conversion Guide
The execution method was designed to give a server-side like experience, similar to SharePoint 2010/2013 solutions. This will help convert existing server-side solutions to client-side solutions.
SPFx Support
Follow the documentation for steps on configuring this library with SPFx projects.
Security
The REST api execute requests based on the user’s permissions. There is no way to elevate privileges requests against the SharePoint REST.