.net core api +swagger(一個簡單的入門demo 使用codefirst+mysql)

前言：

自從.net core問世以後，就一直想了解。可是因爲比較懶惰只是斷斷續續瞭解一點。近段時間工做不是太忙碌，因此偷閒寫下本身學習過程。慢慢了解.net core 等這些基礎方面學會以後再用.net core寫一個項目，前期文章都是爲以後的項目作準備。同時也但願這些基礎文章能幫助更多的想入手 .net core的小白。(文中若有不正確地方歡迎各位指正)

 

開發工具vs2017

數據庫  mysql8.0

.net core環境 .net core2.1

 

1】model層創建

　　先新建一個項目：左側目錄選擇其餘項目類型=》vs解決方案=》空白方案=》本身隨意去個名字

　　添加一個core 內庫做爲model層，

　　因爲本次數據庫使用的是mysql，因此在model層中經過nuget分別引用Microsoft.EntityFrameworkCore.Tools和Pomelo.EntityFrameworkCore.MySql（注意兩個版本必須一致 這裏選自2.1.4版本，以前博主引用版本不對，直接致使鏈接輸出出錯）

　　而後分別添加一個model類和數據庫上下文類，本demo建立一張user表

 

數據庫上下文類DataBase

using Microsoft.EntityFrameworkCore;

namespace Core.Model
{
    public class DataBase : DbContext
    {
        //構造方法
        public DataBase(DbContextOptions<DataBase> options)
            : base(options)
        { }

        #region 數據區域
        public DbSet<User> User { get; set; }
        #endregion

    }
}

View Code

 至此，model建立完畢，後期各位能夠根據本身的須要本身拓展

 

2】建立api層

　　首先在解決方案中建立api層，流程以下圖

建議新手選擇api這一項，建立完畢以後，項目結構如右圖

 　　別忘記在api層添加對model層的引用

　　首先來appsettings.json配置數據庫，127.0.0.1表明本地計算機

 

　　配置完畢以後來到 Startup.cs的ConfigureServices方法將數據庫鏈接配置好，若是此段代碼有飄紅部分，只須要將其缺失的地方引用（須要引用

using Microsoft.EntityFrameworkCore;和using Core.Model;）

   //mysql鏈接
            services.AddDbContextPool<DataBase>(options =>
options.UseMySql(Configuration.GetConnectionString("MySqlConnection")));

View Code

注意括號中的MySqlConnection就是appsettings.json中寫鏈接數據庫字符串的前綴

 

 

 

接下來將原有的控制器刪除，本身添加一個UserController.cs

控制器中代碼（包含增刪查改CRUD）

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Core.Model;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace Core.api.Controllers
{
    [Produces("application/json")]
    [Route("api/admin/[controller]")]
    [ApiController]
    public class UserController : Controller
    {

        private readonly DataBase _context;
        public UserController(DataBase context)
        {
            _context = context;
        }
        #region base

        /// <summary>
        /// 獲取單個
        /// </summary>
        /// <param name="id">Id</param>
        /// <returns></returns>
        [HttpGet("{id}")]
        public JsonResult GetById(string id)
        {
            var tt = _context.Set<User>().Where(c => c.id == id).ToList();
            //_context.Set<User>().Add(us);
            //_context.SaveChanges();
            return Json(tt);
        }
        /// <summary>
        /// 添加
        /// </summary>
        /// <param name="entity"></param>
        /// <returns></returns>
        [HttpPost]
        public JsonResult Add(User entity = null)
        {
            _context.Set<User>().Add(entity);
            int num = _context.SaveChanges();

            if (entity == null)
                return Json("參數爲空");
            if (num > 0) { return Json("成功"); }
            else { return Json("失敗"); }
        }
        /// <summary>
        /// 編輯 
        /// </summary>
        /// <param name="entity"></param>
        /// <returns></returns>
        [HttpPut]
        [Route("User")]
        public JsonResult Update(User entity = null)
        {

            _context.Set<User>().Update(entity);
            int num = _context.SaveChanges();
            if (entity == null)
                return Json("參數爲空");
            if (num > 0) { return Json("成功"); }
            else { return Json("失敗"); }
        }

        /// <summary>
        /// 刪除 
        /// </summary>
        /// <param name="ids"></param>
        /// <returns></returns>
        [HttpDelete]
        public JsonResult Dels(string ids = null)
        {
            if (ids.Length == 0)
                return Json("參數爲空");
            var tt = _context.Set<User>().Where(c => c.id == ids).First();
            _context.Set<User>().Remove(tt);
            int num = _context.SaveChanges();
            if (num > 0) { return Json("成功"); }
            else { return Json("失敗"); }
        }
        #endregion
    }
}

View Code

自此一個簡單的api基本完成，須要運行檢驗還須要一個步驟。

3】swagger

爲了檢測接口運行，這裏選擇swagger

首先在api層經過nuget引用Swashbuckle.AspNetCore

 

而後右鍵單擊core.api項目選擇屬性，打開一個新面板以後選擇左側的生成菜單=》扎到輸出提示。選擇輸出路徑bin\Debug\netcoreapp2.1\=》勾選xml文檔文件

而後回到 Startup.cs ，分別加入如下代碼 

 此處須要先在nuget中引用 Microsoft.Extensions.PlatformAbstractions

注意 上文中生成的core.api.xml寫入到下列方法中 ，名字要保持一致，否者報錯

     #region Swagger
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info
                {
                    Version = "v1.1.0",
                    Title = "Ray WebAPI",
                    Description = "框架集合",
                    TermsOfService = "None",
                    Contact = new Swashbuckle.AspNetCore.Swagger.Contact { Name = "RayWang", Email = "2271272653@qq.com", Url = "http://www.cnblogs.com/RayWang" }
                });
                //添加讀取註釋服務  nuget  Microsoft.Extensions.PlatformAbstractions
                var basePath = PlatformServices.Default.Application.ApplicationBasePath;
                var xmlPath = Path.Combine(basePath, "Core.api.xml");//此處爲生成xml文檔
                c.IncludeXmlComments(xmlPath);
               
            });
            #endregion

View Code

 

 

  #region Swagger
            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "ApiHelp V1");
            });
            #endregion

View Code

，最後來到launchSettings.json修改如下代碼，將api/value修改成swagger，表示項目已啓動就顯示Swagger的主頁面，而不用經過輸入路勁

 

由於本項目是codefirst，因此最後在項目啓動以前別忘記在nuget控制檯運行如下兩行代碼

先輸入：Add-Migration  MyFirstMigration(名字。這裏隨意取未MyFirstMigration)
 在輸入：Update-Database  

補充一個小問題，博主首次在nuget控制檯輸入

Add-Migration  MyFirstMigration的時候不知道爲何報錯，後來先輸入Add-Migration  而後隨意取一個名字才成功。以前未碰見過。若是遇到此類錯誤的讀者能夠先試試我這個辦法。

 

 

最後】最後運行代碼，就會看到頁面以下

添加一條數據進行嘗試，單擊綠色post=》單擊try it out =》輸入數據（這裏我所有輸入「測試」）=》單擊execute

而後鼠標下滑，就能夠看到返回的結果

而後進入數據庫驗證，發現數據插入成功