URLDispatcher

URLDispatcher[{patt1content1,patt2content2,…}]

represents a dispatcher for deployed URLs that specifies that URLs with relative paths matching the string patterns patti should give content represented by contenti.

Details

  • CloudDeploy[URLDispatcher[…]] yields a cloud object corresponding to an active URL dispatcher. All URLs relative to the URL of this cloud object are normally interpreted using the URL dispatcher.
  • Specific deployment of a cloud object to a particular URL, e.g. by CloudDeploy, overrides any rule for that URL given by a URL dispatcher.
  • In the URLs specified by URLDispatcher, the patti are treated as textually appended to the base URL defined by the URL of the deployed URL dispatcher.
  • In CloudDeploy[URLDispatcher[{patt1:>…,…}]], the patti must start with /.
  • Trailing characters in URLs are by default ignored when the URLs are matched. To force an exact match to the end of a URL, include EndOfString in the string pattern.
  • The contenti must be content suitable for deployment using CloudDeploy.
  • The contenti can contain URLDispatcher.
  • When there are nested URLDispatcher specifications, each successive specification is given whatever trailing part of the URL remains after matching preceding specifications.

Examples

open allclose all

Basic Examples  (2)

URLDispatcher can be used with simple strings:

Visiting https://www.wolframcloud.com/objects/user-b0c28e9f-876d-4478-9d8b-9e7d18a9ea81/application/form yields a FormFunction:

Visiting https://www.wolframcloud.com/objects/user-b0c28e9f-876d-4478-9d8b-9e7d18a9ea81/application/api yields an APIFunction:

Visiting the bare URL of the CloudObject yields a page not found error:

URLDispatcher also supports generic string patterns:

Generalizations & Extensions  (1)

URLDispatcher can be nested:

Visiting https://www.wolframcloud.com/objects/527ac761-7022-43c0-a01a-2bc5255dda1a/thailand yields a map:

        

Visiting https://www.wolframcloud.com/objects/527ac761-7022-43c0-a01a-2bc5255dda1a/thailand/Population yields the population:

        

Possible Issues  (3)

URLDispatcher matches when only the first part of the string matches:

Visiting https://www.wolframcloud.com/objects/3329aa63-b811-444c-90c7-29e527aa9eb5/abc?a=foo yields the following:

        

This means that if a substring matches first, the others will be ignored:

This will always go to the welcome page. To avoid this behavior, use an explicit EndOfString:

URLDispatcher requires an explicit "/" when deployed to a CloudObject. The following always returns a 404 error:

The same is not true when URLDispatcher is nested inside another URLDispatcher:

        
Wolfram Research (2016), URLDispatcher, Wolfram Language function, https://reference.wolfram.com/language/ref/URLDispatcher.html.

Text

Wolfram Research (2016), URLDispatcher, Wolfram Language function, https://reference.wolfram.com/language/ref/URLDispatcher.html.

CMS

Wolfram Language. 2016. "URLDispatcher." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/URLDispatcher.html.

APA

Wolfram Language. (2016). URLDispatcher. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/URLDispatcher.html

BibTeX

@misc{reference.wolfram_2024_urldispatcher, author="Wolfram Research", title="{URLDispatcher}", year="2016", howpublished="\url{https://reference.wolfram.com/language/ref/URLDispatcher.html}", note=[Accessed: 22-November-2024 ]}

BibLaTeX

@online{reference.wolfram_2024_urldispatcher, organization={Wolfram Research}, title={URLDispatcher}, year={2016}, url={https://reference.wolfram.com/language/ref/URLDispatcher.html}, note=[Accessed: 22-November-2024 ]}