map-local-directory.md

Map Local (Directory)

1. What's it?

It's a handy tool to map a matched requests to local files on a selected Directory. If the local files doesn't exist, it will serve from the real server.

If you would like to map a Local File, let check out the Map Local (File) page

{% content-ref url="map-local.md" %} map-local.md {% endcontent-ref %}

2. How to use

2.1 Map a path and its subdirectories

api.proxyman.io/build/v1/* => All sub-paths after /v1/ will map to a selected directory.

For instance, we select ~/desktop/my_folder as the local directory

Real URL	Resolved Local Path
http://api.proxyman.io/build/v1/index.html	~/desktop/my_folder/index.html
http://api.proxyman.io/build/v1/js/main.js	~/desktop/my_folder/js/main.js

How to config

Rule	How to use	Examples
Wildcard	Check ON "Include subpaths" checkbox Or use /* at the end of the URL	api.proxyman.io/build/v1/ (Check ON) api.proxyman.io/build/v1/*
Regex	Use (.*) at the end	https://api.proxyman.io/build/v1/(.) https://api.proxyman.io/build/v1/(..css)

{% hint style="info" %} Make sure you use () group Regex operator to tell Proxyman where to map {% endhint %}

2.2 Map Entire Host

api.proxyman.io/* => All sub-paths will map to a selected directory.

For instance, we select ~/desktop/my_folder as the local directory

Real URL	Resolved Local Path
http://api.proxyman.io/build/v1/index.html	~/desktop/my_folder/build/v1/index.html
http://api.proxyman.io/build/v1/js/main.js	~/desktop/my_folder/build/v1/js/main.js

How to config

Rule	How to use	Examples
Wildcard	Leave the path blank	api.proxyman.io
Regex	Use single path that contains (.*) at the end	https://api.proxyman.io/(.) https://api.proxyman.io/(.html)

3. Map Local Directoy with Scripting Tool ✅

If you would like to do Map Local Directory with complicated rules, you might check out Scripting since it's easier to achieve the same result.

Please check out our Snippet Code to understand how to map a local file with Javascript Code.