配置ASP.NET WebAPI

标签: ASP.NET WebApi  c#

1 配置路由规则

找到网站文件目录,选择“App_Start”文件夹中的WebApiConfig.cs文件并打开。如下图所示。
在这里插入图片描述
打开WebApiConfig.cs文件后,按照如下代码进行修改。修改后可以在Controller中写不同的Post方法和Get方法。

    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 }
            //);
            
            // 修改后的路由配置
            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{action}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
        }
    }

2 配置网页文档中的注释

在启动项目之后要查看接口的中文注释,需要按照如下操作进行一些配置。
右击WebAPI项目,选择属性。如下图所示。
在这里插入图片描述
选中“生成”,到最下方选中XML文档文件,复制文档路径。如下图所示。
在这里插入图片描述
到目录“Areas\HelpPage\App_Start”中,找到HelpPageConfig.cs文件并打开。如下图所示。
在这里插入图片描述
打开HelpPageConfig.cs文件后,找到Register方法,在此方法中找到如下代码进行修改。

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/bin/PTL.BackEnd.xml")));

在最后的MapPath("")中将刚才复制的XML文件的路径添加进去。

3 配置数据库连接字段

在这个项目中,我使用了SQL Server作为数据库,因此这里只放SQL Server的配置方法。
找到项目的Web.config文件。在<configuration></configuration>标签中添加如下代码。

<configuration>
	<connectionStrings>
		<add name="PTL_DBConnection" connectionString="Data Source=DESKTOP-HRE7PQN\SQLEXPRESS;Initial Catalog=PalletBarcode1;User ID=root;Password=root;Connect Timeout=30;Encrypt=False;TrustServerCertificate=False;ApplicationIntent=ReadWrite;MultiSubnetFailover=False" providerName="System.Data.SqlClient" />
	</connectionStrings>
</configuration>

配置完数据库连接字段后,在.cs文件中引用时使用如下代码。

string strConnection = System.Configuration.ConfigurationManager.ConnectionStrings["PTL_DBConnection"].ConnectionString

4 WebApi跨域请求

在Web.config文件中找到<system.webServer></system.webServer>标签下,添加如下代码。

<httpProtocol>
    <customHeaders>
        <add name="Access-Control-Allow-Origin" value="*"/>
        <add name="Access-Control-Allow-Headers" value="*"/>
        <add name="Access-Control-Allow-Methods" value="GET, POST, PUT, DELETE"/>
    </customHeaders>
</httpProtocol>

按照如上方法进行配置后,WebApi项目基本能够正常使用了。

版权声明:本文为weixin_42727319原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/weixin_42727319/article/details/106833382