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

来源:https://www.cnblogs.com/1439107348s/archive/2018/12/05/10070631.html
-Advertisement-
Play Games

前言: 自從.net core問世之後,就一直想瞭解。但是由於比較懶惰只是斷斷續續瞭解一點。近段時間工作不是太忙碌,所以偷閑寫下自己學習過程。慢慢瞭解.net core 等這些基礎方面學會之後再用.net core寫一個項目,前期文章都是為之後的項目做準備。同時也希望這些基礎文章能幫助更多的想入手 ...


前言:

自從.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 = "[email protected]", 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

然後滑鼠下滑,就可以看到返回的結果

然後進入資料庫驗證,發現數據插入成功

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 本文采用Nginx來實現ASP.NET程式集群化。 準備環境 首先準備Nginx環境,Windows版本下載鏈接:http://nginx.org/en/download.html 解壓後文件格式如下: 修改配置文件 打開 conf 文件夾中的 nginx.conf 配置文件 配置說明: 1.lis ...
  • 近日逛招聘軟體,看到部分企業都要求會編寫、請求restFul的webapi。正巧這段時間較為清閑,於是乎打開vs準備開擼。 1.何為restFul? restFul是符合rest架構風格的網路API介面。 rest是一種軟體架構的編碼風格,是根據網路應用而去設計和開發的一種可以降低開發複雜度的編碼方 ...
  • 最近公司項目上線,之前利用串口通訊實現校牌的無感知簽到程式, 項目上線以後剛剛好有時間把之前的出現的問題做下記錄,廢話不多,直接到主題 串口介紹: 串列介面簡稱串口,也稱串列通信介面或串列通訊介面(通常指COM介面),是採用串列通信方式的擴展介面。(至於再詳細,自己百度) 正文: 最近在公司讓用C# ...
  • 在Excel中,添加的控制項可以和單元格關聯,我們可以操作控制項來修改單元格的內容,在下麵的文章中,將介紹在Excel中添加幾種不同的表單控制項的方法,包括: 添加文本框(Textbox) 單選按鈕(Radio button) 覆選框(Checkbox) 組合框(combo Box) 使用工具 Free ...
  • pq實例圖 如下 : int x=12,y=10; int a; a=x&y; //a=8 下麵是計算試子的和加減法一樣 二進位的個位,十位,百位,千位,分別對應的是1,2,4,8 二進位每多一位只需要乘2 那個個位置有1 就加上該位置的十進位數 。 上面說&運算時,當兩個二進位操作位都為1時,結果 ...
  • 最近在做個微信公眾號的項目,需要將入口放置在公眾號二級菜單內,通過點擊該菜單鏈接後進入到該項目中去,進入到項目後程式會自動通過微信公眾號的API完成用戶的OpenId獲取。需求很簡單,實現起來也不複雜,於是在一番折騰後需求實現了。為此,寫下此文僅為初次接觸的朋友提供個小小的幫助。 ...
  • DataGridView控制項中的各種事件都無法直接響應Cell中內容的變化,包括KeyPress等事件,可以採用下麵方法 註:此方法無法響應Cell中的回車鍵 ...
  • 路由設置 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...