2

I am authoring a RESTful WCF service using .Net 4.0. I want the following two URLS:

/root/document/{ids}?fields={fields}
/root/externaldocument/{ids}?fields={fields}

to map to the same interface member:

Documents GetDocuments(string ids, string fields)

I have tried putting a wildcard into a literal URL segment:

    [OperationContract]
    [WebGet(UriTemplate = "/root/*document/{ids}?fields={fields}")]
    Documents GetDocuments(string ids, string fields)

However, this is not valid and I get the following exception:

The UriTemplate '/root/*document/{ids}?fields={fields}' is not valid; the 
wildcard ('*') cannot appear in a variable name or literal... Note that a 
wildcard segment, either a literal or a variable, is valid only as the last 
path segment in the template

If I wrap the wildcard segment in a template brace:

    [OperationContract]
    [WebGet(UriTemplate = "/root/{*document}/{ids}?fields={fields}")]
    Documents GetDocuments(string ids, string fields)

Then I get an exception because there is no such input parameter in the method arguments:

Operation 'GetDocuments' in contract 'IAPIv2' has a UriTemplate that expects a 
parameter named 'DOCUMENTS', but there is no input parameter with that name 
on the operation.

My workaround is simply to have two entries, pointing to different methods, and then have the methods call a common implementation:

    [OperationContract]
    [WebGet(UriTemplate = "/root/document/{ids}?fields={fields}")]
    Documents GetDocuments(string ids, string fields)

    [OperationContract]
    [WebGet(UriTemplate = "/root/externaldocument/{ids}?fields={fields}")]
     Documents GetExternalDocuments(string ids, string fields)

But this seems kind of ugly.

I have read the documentation and cannot find this point specifically address. Is there any way I can have a wildcard literal segment in WCF? Or is this not possible in WCF?

Joe Alfano
  • 10,149
  • 6
  • 29
  • 40
  • Is there any difference at all between the document vs externaldocument functionality? It seems like if they both map to the same function with the same arguments, then you don't need to make the distinction in the Uri between the two. – Adam S Dec 19 '12 at 17:08
  • Good point Adam, thanks for pointing that out. As it turned out, the two methods actually did have to have slight differences. Thus I solved the problem by creating a parameter capture group in the second URI segment, as I described in my answer below. – Joe Alfano Dec 26 '12 at 22:08

1 Answers1

1

As it turned out, the two entry points needed to have slightly different functionality. So I needed to capture which URL was used to enter the method. What I ended up doing was the following:

[OperationContract]
[WebGet(UriTemplate = "/root/{source}ocuments/{ids}?fields={fields}")]
DocumentCollection GetDocumentsById(string source, string ids, string fields);

Both URLs:

/root/document/{ids}?fields={fields}
/root/externaldocument/{ids}?fields={fields}

map to the same URL template, and thus I needed to have only a single entry with a single UriTemplate in my interface.

The "source" input parameter captures either "d" if the second segment is "documents or "externald" if the second segment is "externaldocuments". Thus by inspecting this input parameter, the method can react appropriately, depending upon which URL was used to reach the method.

Note that I could not use the following for the UriTemplate:

[WebGet(UriTemplate = "/root/{source}documents/{ids}?fields={fields}")]

because in this case, the incoming URL

/root/document/{ids}?fields={fields}

would not match the template, even though the template matches if an empty string ("") is used for the source input parameter. Apparently the UriTemplate matching algorithm requires there to be at least one character in a parameter capturing group for there to be a match.

Joe Alfano
  • 10,149
  • 6
  • 29
  • 40