Asp.NET Core基础 第二篇 Core WebAPI连接Sqlserver数据库及服务发布

 

 

第二篇  Asp.Net Core WebAPI 连接Sqlserver数据库及WebAPI服务发布

 

      前言  Core API可以在业务与数据的模式下提供了一项安全、可靠的数据接口服务方式，我们借助于Core API可以为移动端、物联网终端、互联网终端等设备提供在线数据访问服务，本文重点介绍Core API项目创建、Sqlserver数据CRUD操作、服务发布（WinDows服务器和Linux服务器），侧重入门实操，大侠绕步！

      学习目标：

       1）使用Vs2019创建Core API项目；

       2）如何实现Core API连接Sqlserver数据库，并且实现CRUD操作；

       3）搭建Swagger，实现可视化的API页面。

       4）在Windows和Linux服务器发布Core API应用。

      前期准备工具：

      Vs2019 IDE环境、Sqlserver2008、Windows服务器、Linux服务器。

 

       一、使用Vs2019创建WebAPI项目

　　新建一个项目名称为WebApi的工程，Core版本选择3.1，项目类型选择“ASP.NET Core Web API”，如下图所示

 

 

 

 

 

 

 

 

 　　使用项目模板自动生成了一个未来5天天气情况的Json字符串，运行后如下图所示：

[{
    "date": "2021-11-25T15:15:48.3451682+08:00",
    "temperatureC": 3,
    "temperatureF": 37,
    "summary": "Scorching"
}, {
    "date": "2021-11-26T15:15:48.3481578+08:00",
    "temperatureC": 17,
    "temperatureF": 62,
    "summary": "Scorching"
}, {
    "date": "2021-11-27T15:15:48.3481611+08:00",
    "temperatureC": -9,
    "temperatureF": 16,
    "summary": "Bracing"
}, {
    "date": "2021-11-28T15:15:48.3481614+08:00",
    "temperatureC": 49,
    "temperatureF": 120,
    "summary": "Hot"
}, {
    "date": "2021-11-29T15:15:48.3481615+08:00",
    "temperatureC": 35,
    "temperatureF": 94,
    "summary": "Warm"
}]

　　项目中的文件和文件夹主要有：Controllers（控制器），appsettings.json（配置数据库等连接参数），Program.cs（软件启动项设置），Startup.cs（注册路由和服务）

       二、建立SqlServer数据库CRUD操作

      　　 2.1 配置Sqlserver参数，导入Core Nuget程序包

　　      Core Web API和MVC配置类似，需要先导入NuGet包，appsettings.json文件中配置Sql数据库连接参数，Startup.cs中配置连接服务。

　　三个NuGet包分别为：Microsoft.EntityFrameworkCore（5.0.12）、Microsoft.EntityFrameworkCore.SqlServer、Microsoft.EntityFrameworkCore.Tools、Microsoft.VisualStudio.Web.CodeGenerators.Design

 

　　右键点击项目资源，选择“管理NuGet程序包”

　　

 

 

 　　在appsetting.json文件中设置数据库连接字符串

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "MVCSqlContext": "Server=localhost;Database=InfoUser;User ID=sa;Password=sa;"
  }
}

　　在Startup.cs文件中配置连接服务，如下图所示

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllersWithViews();
            //下面为加入的数据库服务，注意MVCSqlContext修改为自己的文件名
            services.AddDbContext<InfoUserContext>(options =>
                    options.UseSqlServer(Configuration.GetConnectionString("MVCSqlContext")));



            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_3_0);
        }

　　

　　2.2 添加Model模型类、用于CRUDSqlserver数据业务的控制器

　　      首先，在Sqlserver数据库创建数据库名为InfoUser的数据库，建立一个UserData表，表结构如下：

 

 

 

　　在项目中添加一个“Models”文件夹，右键点击Models添加类文件，类的名称为UserData

 

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

namespace MVC_SQL_Test.Models
{
    public partial class UserData
    {
        [Key, Column(Order = 1)]
        public int UserId { get; set; }
        public string UserName { get; set; }
        public string Password { get; set; }
    }
}

 

　　手动添加一个API 控制器，右键点击Models，依次选择“添加”->"控制器"->“EF 控制器”

 

 

 

　　

 

　　控制器自动生成后，点击项目调试运行：https://localhost:44364/api/UserDatas/5，运行结果如下：

 

 

 

      注意：在API项目中也可以同时创建MVC 控制器和Views页面，可参考第一篇。

 

       三、创建Swagger可视化（RESTFull）服务

      　　 第一步：需要导入Swagger NuGet包，右键选中项目依次点击“NuGet包管理器”->输入“Swashbuckle.AspNetCore”

 

 

 

　　　第二步：在Startup.cs文件中注册Swagger服务，代码如下图所示：

 

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.OpenApi.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore;
using WebApi.Data;

namespace WebApi
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {

            services.AddControllers();
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "WebApi", Version = "v1" });
            });

            services.AddDbContext<WebApiContext>(options =>
                    options.UseSqlServer(Configuration.GetConnectionString("WebApiContext")));
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
                app.UseSwagger();
                app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "WebApi v1"));
            }

            app.UseHttpsRedirection();

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }
    }
}

 

 

      最终运行效果如下图所示：