我们公司正在为我们的产品开发API,我们正在考虑使用ASP.NET MVC。在设计我们的API时,我们决定使用下面的调用来让用户以XML格式从API请求信息:
如您所见,传递了多个参数(即artist
和api_key
)。在ASP.NET MVC中,artist
将是controller
,getImages
操作,但是如何将多个参数传递给操作?
这是否可以使用上述格式?
答案 0 :(得分:269)
只需在操作方法中添加参数,即可在MVC中直接支持参数。给出如下行动:
public ActionResult GetImages(string artistName, string apiKey)
MVC将在给定URL时自动填充参数:
/Artist/GetImages/?artistName=cher&apiKey=XXX
另一个特殊情况是名为“id”的参数。任何名为ID的参数都可以放入路径而不是查询字符串,如下所示:
public ActionResult GetImages(string id, string apiKey)
将使用如下所示的URL正确填充:
/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
);
和上面第一个例子一样的方法。
答案 1 :(得分:21)
从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)
答案 2 :(得分:20)
您可以通过查询字符串传递任意参数,但您也可以设置自定义路由以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/
它会将它们带到你的示例查询字符所在的相同位置。
以上只是一个示例,并不适用您必须设置的业务规则和约束,以确保人们不会“破解”该网址。