Universal Links: Is the 'paths' Array Deprecated in Favor of 'components' in AASA?

Question

Created 1w

Replies 1

Boosts 0

Participants 2

Hello! I'm working with universal links in my app and have configured the /.well-known/apple-app-site-association file. Currently, I use the paths array in this file to define URL routing rules. However, I’m struggling to find up-to-date documentation on the pattern syntax supported by the paths field.

 "paths": [
  "/page/*",
  "NOT /page/*/subpage"
]

Could someone clarify:

Is the paths array still officially supported, or is it deprecated in favor of the newer components dictionary (as referenced here https://developer.apple.com/documentation/bundleresources/applinks/details-swift.dictionary/components-swift.dictionary)?

If paths is still valid, where can I find documentation for its pattern-matching capabilities?

I want to ensure my implementation aligns with Apple’s current best practices. Thank you!

Boost

Answer 1

DTS Engineer OP

Apple

1w

The existing format for AASA remains valid and supported. However, I recommend updating the format to the newer one that utilizes the components field. You can find the template below for reference:

 "appIDs": [ "ABCDE12345.com.example.app", "ABCDE12345.com.example.app2" ], 
 "components": [ { 
    "/": "/test/*", 
    "comment": "Matches any URL beginning with /test/" 
    },
    { 
    "/": "/path/1/*", 
    "exclude": true,
    "comment": "Matches any URL beginning with /path/1/ and instructs the system not to open it as a universal link" 
    }]

https://developer.apple.com/documentation/technotes/tn3155-debugging-universal-links/#Host-and-verify-your-AASA

On the same link, you can verify the accuracy of the AASA file by executing the command line command.

 % sudo swcutil verify -d example.com -j ./example.json -u https://example.com/test
{ s = applinks, a = ABCD123.com.example.app, d = example.com }:
Pattern "https://example.com/test" matched.

Alternatively, you may respond to this post by providing the link to the AASA file, and we can help you with the format.

Albert Pascual   Worldwide Developer Relations.

0

	"appIDs": [ "ABCDE12345.com.example.app", "ABCDE12345.com.example.app2" ],
	"components": [ {
	"/": "/test/*",
	"comment": "Matches any URL beginning with /test/"
	},
	{
	"/": "/path/1/*",
	"exclude": true,
	"comment": "Matches any URL beginning with /path/1/ and instructs the system not to open it as a universal link"
	}]

	% sudo swcutil verify -d example.com -j ./example.json -u https://example.com/test
	{ s = applinks, a = ABCD123.com.example.app, d = example.com }:
	Pattern "https://example.com/test" matched.