我们公司正在为我们的产品开发API,并且我们正在考虑使用ASP.NET MVC。在设计API时,我们决定使用如下所示的调用,以便用户以XML格式从API请求信息:
如您所见,传递了多个参数(即artist
和api_key
)。在ASP.NET MVC,artist
将是controller
,getImages
在行动,但我会如何将多个参数传递给动作?
使用上述格式甚至可以做到吗?
我们公司正在为我们的产品开发API,并且我们正在考虑使用ASP.NET MVC。在设计API时,我们决定使用如下所示的调用,以便用户以XML格式从API请求信息:
如您所见,传递了多个参数(即artist
和api_key
)。在ASP.NET MVC,artist
将是controller
,getImages
在行动,但我会如何将多个参数传递给动作?
使用上述格式甚至可以做到吗?
Answers:
只需在操作方法中添加参数,即可在MVC中直接支持参数。采取以下操作:
public ActionResult GetImages(string artistName, string apiKey)
当给定URL时,MVC将自动填充参数,例如:
/Artist/GetImages/?artistName=cher&apiKey=XXX
另一种特殊情况是名为“ id”的参数。任何名为ID的参数都可以放入路径中,而不是查询字符串中,因此类似:
public ActionResult GetImages(string id, string apiKey)
可以使用如下网址正确填充:
/Artist/GetImages/cher?apiKey=XXX
另外,如果您有更复杂的方案,则可以自定义MVC用于定位操作的路由规则。您的global.asax文件包含可以自定义的路由规则。默认情况下,规则如下所示:
routes.MapRoute(
"Default", // Route name
"{controller}/{action}/{id}", // URL with parameters
new { controller = "Home", action = "Index", id = "" } // Parameter defaults
);
如果您想支持以下网址
/Artist/GetImages/cher/api-key
您可以添加一条路线,例如:
routes.MapRoute(
"ArtistImages", // Route name
"{controller}/{action}/{artistName}/{apikey}", // URL with parameters
new { controller = "Home", action = "Index", artistName = "", apikey = "" } // Parameter defaults
);
和上面第一个示例类似的方法。
从MVC 5开始,您还可以使用属性路由将URL参数配置移至控制器。
可在此处进行详细讨论:http : //blogs.msdn.com/b/webdev/archive/2013/10/17/attribute-routing-in-asp-net-mvc-5.aspx
摘要:
首先,您启用属性路由
public class RouteConfig
{
public static void RegisterRoutes(RouteCollection routes)
{
routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
routes.MapMvcAttributeRoutes();
}
}
然后,您可以使用属性来定义参数和可选的数据类型
public class BooksController : Controller
{
// eg: /books
// eg: /books/1430210079
[Route("books/{isbn?}")]
public ActionResult View(string isbn)
您可以通过查询字符串传递任意参数,但也可以设置自定义路由以RESTful方式处理它:
http://ws.audioscrobbler.com/2.0/?method=artist.getimages&artist=cher&
api_key=b25b959554ed76058ac220b7b2e0a026
可能是:
routes.MapRoute(
"ArtistsImages",
"{ws}/artists/{artist}/{action}/{*apikey}",
new { ws = "2.0", controller="artists" artist = "", action="", apikey="" }
);
因此,如果有人使用以下路线:
ws.audioscrobbler.com/2.0/artists/cher/images/b25b959554ed76058ac220b7b2e0a026/
将它们带到示例查询字符串所做的相同位置。
上面仅是一个示例,并未应用您必须设置的业务规则和约束来确保人们不会“入侵” URL。