Allows performing API calls to local Express application with forwarding the queries to a remote SharePoint instance.
This concept was created to show how it could be easy to implements real world data communications for SharePoint Framework local serve mode during web parts debug without deployment to SharePoint tenant.
Socket proxying allows to forward API from behind NAT (experimental).
1. Install NPM module in the project:
npm install --save-dev sp-rest-proxy
yarn add sp-rest-proxy --dev
2. Create server.js with the following code:
const RestProxy = ;const settings =configPath: './config/private.json' // Location for SharePoint instance mapping and credentialsport: 8080 // Local server portstaticRoot: './static' // Root folder for static content;const restProxy = settings;restProxy;
3. Add npm task for serve into package.json:
Check if the path to server.js is correct.
npm run serve.
5. Provide SharePoint configuration parameters.
6. Test local API proxy in action.
1. Clone/fork the project:
git clone https://github.com/koltyakov/sp-rest-proxy
2. CMD to the project folder.
3. Install dependencies:
npm run build
5. Run the server:
npm run serve
or serve in TypeScript directly
npm run ts-serve
Prompts credentials for a SharePoint site.
6. Navigate to http://localhost:8080 (or whatever in settings)
7. Ajax REST calls as if you were in SharePoint site page context:
npm run test
The proxy provides wizard-like approach for building and managing config files for
node-sp-auth (Node.js to SharePoint unattended http authentication).
sp-rest-proxy works with PnP JS Core (not POST request, as there is an endpoint transformation during POST request in PnP JS Core):