如何在MVC4项目中调用/引用外部web api项目

时间:2015-07-24 05:12:36

标签: c# asp.net-mvc asp.net-web-api


我不熟悉Web API& MVC
我创建了新的WEB API& MVC解决方案单独现在我想在MVC中引用Web API动作方法,所以对于我写的下面的代码,
Web Api Project Side,

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Data;
using System.Net.Http;
using System.Web.Http;
using AttributeRouting.Web.Mvc;
using RegisterStudent_WebAPI.Models;

    namespace Register_Student_WebAPI.Controllers 
    {
        public class RegisterStudentController : ApiController
        {
            [Route("api/student")]
            [HttpGet]
            public IEnumerable<Student> GetStudents()
            {
                RegisterStudent_API_DB objRegisterStudent = new RegisterStudent_API_DB();
                List<Student> lstStudent = objRegisterStudent.GetStudent();
                return lstStudent ;
            }
        } }

来自API的WEB.Config文件,

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http;


namespace RegisterStudent_WebAPI
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {


            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );

            // Uncomment the following line of code to enable query support for actions with an IQueryable or IQueryable<T> return type.
            // To avoid processing unexpected or malicious queries, use the validation settings on QueryableAttribute to validate incoming queries.
            // For more information, visit http://go.microsoft.com/fwlink/?LinkId=279712.
            //config.EnableQuerySupport();

            // To disable tracing in your application, please comment out or remove the following line of code
            // For more information, refer to: http://www.asp.net/web-api
            config.EnableSystemDiagnosticsTracing();


            config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new System.Net.Http.Headers.MediaTypeHeaderValue("text/html"));
        }
    }
}


在MVC项目中,我已经在脚本标记(在加载表单中)编写了以下代码来引用WEB API服务,

$(document).ready(function () {   
        jQuery.support.cors = true;
        $.ajax({
            url: 'http://localhost:18715/api/student',
            type: 'GET',
            dataType: 'json',
            success: function (data) {
                alert('success');
            },
            error: function (x) {
                alert(x.status);
            }
        });
    });

如果我将Web API项目的引用添加到MVC项目,那么它工作正常但我的一位朋友告诉服务不应该这样推荐,请指导我如何引用/包含托管/跨域运行web api项目到我的MVC项目?

1 个答案:

答案 0 :(得分:0)

你所做的一切都不错(至少 - 它是不被禁止的;))但是通过直接在MVC项目中引用WebAPI,你将它绑定到一个特定的应用程序,什么会阻止你在其他方面重用API项目/服务。

在我看来,WebAPI项目应作为另一个应用程序托管(由您决定它是否应该是一个自托管的OWIN应用程序/ Web服务/简单的API应用程序),这给您带来了一些好处:

  • 它与您的MVC应用程序逻辑分开
  • 可以单独部署
  • 它可以被其他应用程序/服务使用
  • 更容易维护

将WebAPI视为RESTful Web服务,这是一种可供您的应用程序或第三方应用程序使用的API。

老实说,直接在MVC中使用WebAPI只是为了提供你的观点,一些数据似乎有点浪费。由于MVC控制器中的JsonResult操作,您可以完成的工作。它并不理想,但会妨碍您创建另一个API项目。