具有空参数的 $http.get 未命中 Web API 控制器

Question

我正在尝试使用$http访问Web API get控制器。按如下方式进行角度应用：

$http.get(BasePath + '/api/documentapi/GetDocuments/' , 
                                {
                                    params: {
                                        PrimaryID: ID1,
                                        AlternateID: ID2,                                            
                                    }
                                }).then( ...

在我的例子中，PrimaryID或AlternateID都具有该值。因此，其中一个将始终为空。

我的Web api方法是

public DocumentsDto[] GetDocuments(decimal? PrimaryID, decimal? AlternateID)
    { ...

当其中一个值为 null 时，$http.get 生成的 url 如下所示：

http://BaseServerPath/api/documentapi/GetDocuments/?PrimaryID=1688 

或者

 http://BaseServerPath/api/documentapi/GetDocuments/?AlternateID=154

这不符合我的Web API方法。

但是，如果我使用

http://BaseServerPath/api/documentapi/GetDocuments/?PrimaryID=1688&AlternateID=null

它工作了。我可以在我的参数中将值硬编码为null，但是我想知道是否有正确的方法来实现这一点。

谢谢山姆

Answer 1

还有一个选项可以是将请求参数转换为复杂对象，并使用[FromUri]从Url创建对象。

Answer 2

尽管您已经在Web API控制器上指定这两个参数可以为空，但是ASP.NET路由引擎仍然会在对该方法的调用中寻找两个参数——即使其中一个为空。

理想情况下，您应该创建两个方法，一个只接受主方法，另一个只接受次方法，但是在您的情况下，这有点棘手，因为您的两个id属于同一类型。尽管您可以指定哪个参数对应于查询字符串中提供的值，但这两种方法在您的控制器类中将具有相同的签名(类型为< code>decimal的单个参数)。

所以你在这里有两个选择。要么创建新的控制器，以便有一个接收 PrimaryID 查询和一个 Secondary ID 查询的控制器，或者你有一个方法将一个包含一个 ID 设置为值和另一个设置为 null 的对象，并基于该方法运行查询。

Answer 3

我从@RobJ得到了正确的答案。他发布了答案的链接。我也在这里粘贴了相同的答案。解决方案是为Web API参数设置默认值。

public string GetFindBooks(string author="", string title="", string isbn="", string  somethingelse="", DateTime? date= null) 
{
    // ...
}

就我而言，这将是

public DocumentsDto[] GetDocuments(decimal? PrimaryID = null, decimal? AlternateID = null)
{ ...