使用Visual Studio创建ASP.NET Web API项目

在本篇文章中将讲解如何使用Visual Studio创建一个新的ASP.NET Web API项目。

在VisualStudio中有两种方式用于创建WebAPI项目：

1、创建带MVC的WebAPI项目。

2、创建独立的WebAPI项目。

一、创建带MVC的WebAPI项目

在示例程序中使用的是VisualStudio 2013版本，创建一个新的WebAPI项目并且带MVC的模板，它包含了所有必要的引用。

1、选择“文件”->“新建”->“项目”，截图如下所示：

2、在弹出的新建项目窗口中，左侧模板选择Visual C#->Web，中间面板选择ASP.NET Web应用程序，输入项目名称，点击确定，界面如下：

3、在弹出的新建ASP.NET项目的窗口中，模板类型选择Web API，会看到下面默认勾选了MVC和Web API的复选框，这意味着它将添加MVC和WebAPI必要的文件夹和相关引用。点击确定按钮，界面截图如下：

4、新建的WebAPI项目结构如下图所示

这个项目就是一个默认的MVC项目加两个为WebAPI准备的特定文件：即App_Start文件夹中的WebApiConfig.cs和Controllers文件夹中的ValuesController.cs文件。

WebApiConfig.cs是WebAPI的配置文件，可以配置WebAPI路由和其他信息，跟MVC的RouteConfig.cs文件的作用相同。内容如下图所示：

ValuesController.cs是默认创建的WebAPI的控制器，包括WebAPI中常用的几个方法，内容如下图所示：

到此为止，已经成功创建了一个带MVC的WebAPI项目。

二、创建独立的WebAPI项目

在上面讲解了如何使用VisualStudio创建一个带MVC的WebAPI项目，接下来将会讲解如何创建一个独立的WebAPI项目。

1、选择“文件”->“新建”->“项目”，截图如下所示：

2、在弹出的新建项目窗口中，左侧模板选择Visual C#->Web，中间面板选择ASP.NET Web应用程序，输入项目名称，点击确定，界面如下：

3、在弹出的新建ASP.NET项目的窗口中，模板类型选择Empty，点击确定按钮，界面截图如下：

4、这时将创建一个空的WebAPI项目。项目结构如下：

现在，我们需要使用NuGet包管理器添加最新的WebAPI引用。

5、右键单击项目，然后单击“管理NuGet程序包”，界面截图如下：

6、打开管理NuGet程序包界面，在搜索框里输入“WebAPI”，选择Microsoft ASP.NET Web API2.2包并点击安装，界面如下所示：

7、出现如下图所示的界面表示WebAPI安装成功

8、在项目中创建配置文件夹，并添加配置类，配置类定义如下：

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

namespace IndependentWebAPI.Configuration
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API 配置和服务

            // Web API 路由
            config.MapHttpAttributeRoutes();

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

9、添加Global.asax文件。

右键点击项目，选择“添加”->“新建项”，界面截图如下：

10、在添加新项界面，选择web下面的“全局应用程序类”，并命名为“Global.asax”，点击添加按钮，这样就将Global.asax文件添加到了项目中。界面截图如下所示：

11、配置应用程序启动时的WebAPI的路由。

需要在Global.asax文件的Application_Start方法中调用WebApiConfig.Register()方法来配置WebAPI。Application_Start()方法定义如下：

protected void Application_Start(object sender, EventArgs e)
{
       GlobalConfiguration.Configure(WebApiConfig.Register);
}

配置Web API只需要使用基于代码的配置GlobalConfiguration 类。因此,当应用程序启动,它将调用Application_Start事件，进而调用HelloWebAPIConfig.Register()方法来配置您的Web API。

12、添加控制器

在项目上右键添加Controller文件夹，然后在新添加的Controller文件夹上右键选择“添加”->“控制器”，界面截图如下：

13、在添加基架界面选择WebAPI下面的WebAPI 2控制器 -空，点击添加按钮。截图如下所示：

14、在添加控制器界面，输入控制器的名称（控制器以Controller结尾），并点击添加按钮。截图如下所示：

15、为控制器类添加简单的GET方法，GET()方法定义如下：

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

namespace IndependentWebAPI.Controller
{
    public class HomeController : ApiController
    {
        [HttpGet]
        public string Get()
        {
            return "Hello World";
        }
    }
}

16、编译并运行项目，输出结果如下图所示：

这样就创建了一个独立的WebAPI项目。

到此这篇关于使用Visual Studio创建ASP.NET Web API项目的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持我们。

赞 (0)

相关推荐

  • asp.net core webapi项目配置全局路由的方法示例

    一.前言 在开发项目的过程中,我新创建了一个controller,发现vs会给我们直接在controller头添加前缀,比如[Route("api/[controller]")],即在访问接口的时候会变成http://localhost:8000/api/values,但是如果控制器有很多个,或者要进行版本迭代时,我们会发现痛苦的时刻降临了,要一个一个的修改. 如果在这个时候可以进行全局配置前缀那真是福利呀,修改一处即可.为了能达到此目的我们就来运用一下吧. 二.配置 0.在配置前我们

  • .Net Core3.0 WebApi 项目框架搭建之使用Serilog替换掉Log4j

    .Net Core3.0 WebApi 项目框架搭建之使用Serilog替换掉Log4j

    为什么使用Serilog Serilog 是一个用于.NET应用程序的日志记录开源库,配置简单,接口干净,并可运行在最新的.NET平台上,与其他日志库不同, Serilog 是以功能强大的结构化事件数据为基础构建的, 支持将日志输出到控制台.文件.数据库和其它更多的方式,支持参数化日志模板,非常灵活. 之前我们项目使用的是Log4j来记录用户日志的,在开发的过程中,慢慢的发现Log4j好像并不能满足我们的需求,比如结构化,日志分析等,于是决定使用serilog来替换掉Log4j,在使用的过程中发

  • 创建一个完整的ASP.NET Web API项目

    创建一个完整的ASP.NET Web API项目

    Visual Studio为我们提供了专门用于创建ASP.NET Web API应用的项目模板,借助于此项目模板提供的向导,我们可以"一键式"创建一个完整的ASP.NET Web API项目.在项目创建过程中,Visual Studio会自动为我们添加必要的程序集引用和配置,甚至会为我们自动生成相关的代码,总之一句话:这种通过向导生成的项目在被创建之后其本身就是一个可执行的应用. 一.通过VS2013..NET 4.5.1创建一个Web API项目 1.解决方案下面新建项目 2.选择项

  • Net Core Web Api项目与在NginX下发布的方法

    前言 本文将介绍Net Core的一些基础知识和如何NginX下发布Net Core的WebApi项目. 测试环境 操作系统:windows 10 开发工具:visualstudio 2019 框架:Net Core 3 Net Core WebApi项目创建 首先创建一个Net Core WebApi项目--CorePublishForNginX. 首先选择Asp.Net Core Web应用程序,如下图: 然后修改项目名称,如下图: 然后选择Api选项,如下图: 项目创建完成,如下图: 代码

  • ASP.NET Core在WebApi项目中使用MiniProfiler分析Entity Framework Core

    ASP.NET Core在WebApi项目中使用MiniProfiler分析Entity Framework Core

    安装配置MiniProfiler 在现有的ASP.NET Core MVC WebApi 项目里,通过Nuget安装MiniProfiler: Install-Package MiniProfiler.AspNetCore.Mvc MiniProfiler.EntityFrameworkCore 当然也可以通过Nuget Package Manager可视化工具安装 接下来就是如何配置和使用 MiniProfiler 了,总共分三步: 第一步,来到Startup.cs的ConfigureServ

  • 使用Visual Studio创建ASP.NET Web API项目

    使用Visual Studio创建ASP.NET Web API项目

    在本篇文章中将讲解如何使用Visual Studio创建一个新的ASP.NET Web API项目. 在VisualStudio中有两种方式用于创建WebAPI项目: 1.创建带MVC的WebAPI项目. 2.创建独立的WebAPI项目. 一.创建带MVC的WebAPI项目 在示例程序中使用的是VisualStudio 2013版本,创建一个新的WebAPI项目并且带MVC的模板,它包含了所有必要的引用. 1.选择“文件”->“新建”->“项目”,截图如下所示: 2.在弹出的新建项目窗口中,左

  • 通过HttpClient 调用ASP.NET Web API示例

    通过HttpClient 调用ASP.NET Web API示例

    在前面两篇文章中我们介绍了ASP.NET Web API的基本知识和原理,并且通过简单的实例了解了它的基本(CRUD)操作.我们是通过JQuery和Ajax对Web API进行数据操作.这一篇我们来介绍一下使用HttpClient的方式来对Web API进行数据操作. 这里我们还是继续使用对Product的操作实例来演示一下它的基本应用. 创建ASP.NET Web API应用程序 在VS中选择创建一个ASP.NET Web Application应用程序,在向导的下一个窗口中选择Web API

  • 支持Ajax跨域访问ASP.NET Web Api 2(Cors)的示例教程

    支持Ajax跨域访问ASP.NET Web Api 2(Cors)的示例教程

    随着深入使用ASP.NET Web Api,我们可能会在项目中考虑将前端的业务分得更细.比如前端项目使用Angularjs的框架来做UI,而数据则由另一个Web Api 的网站项目来支撑.注意,这里是两个Web网站项目了,前端项目主要负责界面的呈现和一些前端的相应业务逻辑处理,而Web Api则负责提供数据. 这样问题就来了,如果前端通过ajax访问Web Api项目话,就涉及到跨域了.我们知道,如果直接访问,正常情况下Web Api是不允许这样做的,这涉及到安全问题.所以,今天我们这篇文章的主

  • ASP.NET Web API如何将注释自动生成帮助文档

    ASP.NET Web API如何将注释自动生成帮助文档

    ASP.NET Web API从注释生成帮助文档 默认情况下,ASP.NET Web API不从Controller的注释中生成帮助文档.如果要将注释作为Web API帮助文档的一部分,比如在帮助文档的Description栏目中显示方法注释中的summary,需要进行一些配置操作. 首先在Visual Studio中打开Web API项目的属性页,在Build设置页,选中XML document file,输入将要生成的XML文件放置的路径,比如:App_Data\OpenAPI.XML. 然

  • Visual Studio 2017 ASP.NET Core开发

    Visual Studio 2017 ASP.NET Core开发

    Visual Studio 2017 ASP.NET Core开发,Visual Studio 2017 已经内置ASP.NET Core 开发工具. 在选择.NET Core 功能安装以后就可以进行ASP.NET Core开发. 新的ASP.NET Core项目为csproj ,打开之前的xproj项目,会提示单向升级,确认以后,会自动帮你升级至csproj. 新建项目 VS 2017新建ASP.NET Core 项目: 确定以后 可选择ASP.NET Core 1.0 和ASP.NET Co

  • ASP.NET Web Api 2实现多文件打包并下载文件的实例

    ASP.NET Web Api 2实现多文件打包并下载文件的实例

    最近由于工作和个人事务,站点也好久没更新了,但这并不影响我对.NET的热情.站点的更新工作还是得想办法抽时间来完成的. 今天利用中午的时间来写一篇关于Asp.Net Web Api下载文件的文章,之前我也写过类似的文章,请见:<ASP.NET(C#) Web Api通过文件流下载文件的实例> 本文以这篇文章的基础,提供了ByteArrayContent的下载以及在下载多个文件时实现在服务器对多文件进行压缩打包后下载的功能. 关于本文中实现的在服务器端用.NET压缩打包文件功能的过程中,使用到了

  • 剖析Asp.Net Web API路由系统---WebHost部署方式

    剖析Asp.Net Web API路由系统---WebHost部署方式

    上一篇我们剖析了Asp.Net路由系统,今天我们再来简单剖析一下Asp.Net Web API以WebHost方式部署时,Asp.Net Web API的路由系统内部是怎样实现的.还是以一个简单实例开头. 创建一个空的WebApi项目,在Global中注册路由信息: public class WebApiApplication : System.Web.HttpApplication { protected void Application_Start() { //注册路由 GlobalConf

  • 推荐8项提高 ASP.NET Web API 性能的技术

    推荐8项提高 ASP.NET Web API 性能的技术

    在本文中,我将介绍8项提高 ASP.NET Web API 性能的技术. 1) 使用最快的 JSON 序列化工具 JSON 的序列化对整个 ASP.NET Web API 的性能有着关键性的影响.在我的一个项目里,我从JSON.NET 序列化工具转到了ServiceStack.Text有一年半了. 我测量过,Web API 的性能提升了20%左右.我强烈建议你去尝试一下这个序列化工具.这里有一些最近的流行序列化工具性能的比较数据. 来源:theburningmonk 更新: 似乎It seams

  • Visual Studio创建WPF项目

    Visual Studio创建WPF项目

    一.简介 WPF(Windows Presentation Foundation)是微软推出的基于Windows 的用户界面框架,属于.NET Framework 3.0的一部分.它提供了统一的编程模型.语言和框架,真正做到了分离界面设计人员与开发人员的工作:同时它提供了全新的多媒体交互用户图形界面. 学习WPF的基础知识:(1)WPF是微软提供的一种用来开发“桌面应用”的技术(框架),这项技术本身和C#没有关系,必须会的是xaml语法.(2)对XML.HTML.XHTML.ASP.NET之类的

随机推荐