【從零開始搭建本身的.NET Core Api框架】（一）建立項目並集成swagger：1.1 建立

系列目錄

一.  建立項目並集成swagger

　　1.1 建立

　　1.2 完善

二. 搭建項目總體架構

三. 集成輕量級ORM框架——SqlSugar

　　3.1 搭建環境

　　3.2 實戰篇：利用SqlSugar快速實現CRUD

　　3.3 生成實體類

四. 集成JWT受權驗證

 

---

 

 

 

先從目的提及：

該系列欲從零開始，以.NET Core爲框架，搭建出一個功能完善的WebApi框架。實現後臺管理系統、前臺系統和App系統的統一管理。

該框架欲集成Swagger做爲接口顯示文檔，集成SqlSugar做爲數據庫操做ORM，集成LayUI做爲後臺管理系統前端框架，集成支付寶和微信的SDK實現支付功能；

實現接口權限驗證功能，實現從後臺管理系統無代碼化的自動生成實體類、自動生成基礎的增刪改查接口、自動生成基礎版的後臺管理頁面；

 

而後這一系列是我在搭建代碼的同時同步編寫的，一方面是當作備忘記錄，一方面也是一種本身對本身的激勵。

因此如下內容會充斥着大量的自言自語，自說自話，請作好心理準備~

 

願望很美好，但仍是要從最基礎的功能開始寫起。

既然說了是從零開始，那就重新建項目開始吧~

 

新建一個ASP.NET Core Web應用程序，取名爲RayPI。

 

這裏選擇API模板

 

生成項目以後，控制器默認生成了一個ValuesController，裏面只有幾個簡單的RESTful風格的接口，分別對應增刪改查的功能，沒有涉及到數據庫數據，只是給咱們做爲參考而已。

 

咱們能夠直接F5進入調試運行狀態，默認調用的是values的獲取集合接口，結果是這樣的：

 

這是一個最基礎、最原生的「光禿禿」的.NET Core API環境，離咱們想要的API框架還很遠，可是其實已經成功一半了，由於好的開始是成功的一半~

 

接下來，咱們要在項目裏集成Swagger插件。

Swagger是一個API接口文檔幫助插件，使用它，能夠將咱們編寫的接口自動生成一個規範化的文檔，其餘開發人員（主要是負責的對接接口的前端人員）就能夠經過瀏覽器訪問對應的地址，查看接口的相關信息。

固然，swagger也提供了基礎的測試功能，這個下一章再講~

 

下面開始引入swagger插件

方法有兩個：

1）能夠去swagger官網或github上下載源碼，而後將源碼（一個類庫）引入本身的項目；

2）直接利用NuGet包添加程序集應用。

由於不多有須要更改swagger源碼的需求，因此這裏咱們選擇比較簡單的第二種方法。

 

依次點擊 工具=>NuGet包管理器=>管理解決方案的NuGet程序包

 

在彈出的頁面中，搜索「Swashbuckle.AspNetCore」，而後勾選RayPI項目（若是解決方案裏有多個類庫，只須要勾選主項目，也就是包含控制器的項目），點擊安裝

 

安裝完成以後，在項目的依賴項裏能夠看到多出了一個引用

 

這時若是運行調試，在域名後面輸入/swagger，會發現wagger尚未起做用，由於尚未在項目的啓動項裏添加swagger服務。

 

下面添加服務：

打開Startup.cs類，編輯ConfigureServices類

// This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services) { services.AddMvc(); #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" } }); }); #endregion }

編輯Configure類

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

 

到這，已經完成swagger的添加，F5運行調試，在域名後面輸入/swagger，點擊回車

 

能夠看到，swagger將咱們項目的接口（這裏只有一個系統默認生成values接口）自動生成一個可視化的接口文檔，點擊對應接口，能夠查看接口的相關信息，也能夠在當前頁進行簡單的測試調用。

 

本章咱們一塊兒從零開始搭建了基於.NET Core 的API原生環境，而且簡單地集成了swagger插件。

下一章，咱們將對swagger進行進一步的詳細設置。