.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
  • 前言 本文介紹一款使用 C# 與 WPF 開發的音頻播放器,其界面簡潔大方,操作體驗流暢。該播放器支持多種音頻格式(如 MP4、WMA、OGG、FLAC 等),並具備標記、實時歌詞顯示等功能。 另外,還支持換膚及多語言(中英文)切換。核心音頻處理採用 FFmpeg 組件,獲得了廣泛認可,目前 Git ...
  • OAuth2.0授權驗證-gitee授權碼模式 本文主要介紹如何筆者自己是如何使用gitee提供的OAuth2.0協議完成授權驗證並登錄到自己的系統,完整模式如圖 1、創建應用 打開gitee個人中心->第三方應用->創建應用 創建應用後在我的應用界面,查看已創建應用的Client ID和Clien ...
  • 解決了這個問題:《winForm下,fastReport.net 從.net framework 升級到.net5遇到的錯誤“Operation is not supported on this platform.”》 本文內容轉載自:https://www.fcnsoft.com/Home/Sho ...
  • 國內文章 WPF 從裸 Win 32 的 WM_Pointer 消息獲取觸摸點繪製筆跡 https://www.cnblogs.com/lindexi/p/18390983 本文將告訴大家如何在 WPF 裡面,接收裸 Win 32 的 WM_Pointer 消息,從消息裡面獲取觸摸點信息,使用觸摸點 ...
  • 前言 給大家推薦一個專為新零售快消行業打造了一套高效的進銷存管理系統。 系統不僅具備強大的庫存管理功能,還集成了高性能的輕量級 POS 解決方案,確保頁面載入速度極快,提供良好的用戶體驗。 項目介紹 Dorisoy.POS 是一款基於 .NET 7 和 Angular 4 開發的新零售快消進銷存管理 ...
  • ABP CLI常用的代碼分享 一、確保環境配置正確 安裝.NET CLI: ABP CLI是基於.NET Core或.NET 5/6/7等更高版本構建的,因此首先需要在你的開發環境中安裝.NET CLI。這可以通過訪問Microsoft官網下載並安裝相應版本的.NET SDK來實現。 安裝ABP ...
  • 問題 問題是這樣的:第三方的webapi,需要先調用登陸介面獲取Cookie,訪問其它介面時攜帶Cookie信息。 但使用HttpClient類調用登陸介面,返回的Headers中沒有找到Cookie信息。 分析 首先,使用Postman測試該登陸介面,正常返回Cookie信息,說明是HttpCli ...
  • 國內文章 關於.NET在中國為什麼工資低的分析 https://www.cnblogs.com/thinkingmore/p/18406244 .NET在中國開發者的薪資偏低,主要因市場需求、技術棧選擇和企業文化等因素所致。歷史上,.NET曾因微軟的閉源策略發展受限,儘管後來推出了跨平臺的.NET ...
  • 在WPF開發應用中,動畫不僅可以引起用戶的註意與興趣,而且還使軟體更加便於使用。前面幾篇文章講解了畫筆(Brush),形狀(Shape),幾何圖形(Geometry),變換(Transform)等相關內容,今天繼續講解動畫相關內容和知識點,僅供學習分享使用,如有不足之處,還請指正。 ...
  • 什麼是委托? 委托可以說是把一個方法代入另一個方法執行,相當於指向函數的指針;事件就相當於保存委托的數組; 1.實例化委托的方式: 方式1:通過new創建實例: public delegate void ShowDelegate(); 或者 public delegate string ShowDe ...