.Net Core WebApi簡單創建及使用

来源:https://www.cnblogs.com/LYF1997/archive/2019/09/10/11473967.html

按照目前的軟體開發發展趨勢中,不管是前後端分離還是提供數據服務,WebApi使用的越來越廣泛,而且.NET Core也是我們.NET開發人員未來發展的趨勢,所以說學會使用.NET Core Api是非常有必要的。 本人作為一個.NET菜鳥,正在慢慢的學習中,將學到的一步一步記錄下來。 一、創建項目 ...


  按照目前的軟體開發發展趨勢中,不管是前後端分離還是提供數據服務,WebApi使用的越來越廣泛,而且.NET Core也是我們.NET開發人員未來發展的趨勢,所以說學會使用.NET Core Api是非常有必要的。

  本人作為一個.NET菜鳥,正在慢慢的學習中,將學到的一步一步記錄下來。

一、創建項目

  打開VS2019,新建一個ASP.NET Core Web 應用程式。

  輸入項目名、選擇路徑創建。

  選擇.NET Core 我這裡用的是.NET Core 2.2版本,選中API,把右邊的選中取消。

  創建的項目目錄內容如下。

二、編輯控制器

  打開Controllers文件夾,這裡我直接使用預設創建的ValuesController控制器。(其實是因為這是個例子我懶的再建了( ̄. ̄))

  ValuesController控制器預設內容如下。 共有四個HTTP方法,分別為 Get、Post、Put 和 Delete。

  把該控制器的內容重新寫一下,將路由設置為api/控制器/方法(api/[controller]/[action])。 按照常用Get 和 Post兩個請求,寫了兩個Get方法和一個Post方法,一個參數類。

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

namespace FirstApi.Controllers
{
    //路由設置
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        /// <summary>
        /// 獲取文本
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public ActionResult<string> Get()
        {
            return "Hello World!";
        }
        /// <summary>
        /// 兩數相加
        /// </summary>
        /// <param name="num1">第一個數</param>
        /// <param name="num2">第二個數</param>
        /// <returns></returns>
        [HttpGet]
        public ActionResult<int> Sum(int num1,int num2)
        {
            return num1 + num2;
        }
        /// <summary>
        /// 兩數相減
        /// </summary>
        /// <param name="param">參數</param>
        /// <returns></returns>
        [HttpPost]
        public ActionResult<int> Subtract(Param param)
        {
            int result = param.num1 - param.num2;
            return result;
        }
    }
    /// <summary>
    /// 參數
    /// </summary>
    public class Param
    {
        /// <summary>
        /// 第一個數
        /// </summary>
        public int num1 { get; set; }
        /// <summary>
        /// 第二個數
        /// </summary>
        public int num2 { get; set; }
    }
}

  然後右鍵項目→屬性→調試,將啟動瀏覽器預設指向為第一個Get方法。

  調試運行,訪問第一個方法,返回結果。

  訪問第二個方法加上參數,得到結果。

  第三個方法是Post請求,無法直接輸入,可以用其他方式實現。

三、搭建Swagger

  這樣WebApi 就簡單實現了,不過這樣不容易管理。為了更好的管理和測試我們的介面,我這裡使用了Swagger框架。

  Swagger是什麼?Swagger 是一個規範和完整的框架,用於生成、描述、調用和可視化RESTful風格的 Web 服務。

  右鍵項目,點擊管理NuGet程式包。

  切換到瀏覽,搜索“Swashbuckle.AspNetCore”,安裝。

  安裝完成之後,編輯Startup.cs文件。

  引用下麵三個命名空間。

using System.IO;
using System.Reflection;
using Swashbuckle.AspNetCore.Swagger;

  在ConfigureServices方法裡加入下麵的代碼,註冊Swagger生成器,定義一個文檔,設置xml文檔的註釋路徑,。

//配置Swagger
//註冊Swagger生成器,定義一個Swagger 文檔
services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new Info
    {
        Version = "v1",
        Title = "介面文檔",
        Description = "RESTful API"
    });
    // 為 Swagger 設置xml文檔註釋路徑
    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
    c.IncludeXmlComments(xmlPath);
});

  在Configure方法裡加入下麵的代碼,啟用中間件服務使用生成Swagger和SwaggerUI,將SwaggerUI中的RoutePrefix設為空字元串,這樣就能在根節點(http://localhost:port)直接顯示SwaggerUI界面。

//啟用中間件服務生成Swagger
app.UseSwagger();
//啟用中間件服務生成SwaggerUI,指定Swagger JSON終結點
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web App V1");
    c.RoutePrefix = string.Empty;//設置根節點訪問
});

  編輯後Startup.cs完整代碼如下。

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Swashbuckle.AspNetCore.Swagger;

namespace FirstApi
{
    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.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            //配置Swagger
            //註冊Swagger生成器,定義一個Swagger 文檔
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info
                {
                    Version = "v1",
                    Title = "介面文檔",
                    Description = "RESTful API"
                });
                // 為 Swagger 設置xml文檔註釋路徑
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath);
            });
        }

        // 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();
            }
            //啟用中間件服務生成Swagger
            app.UseSwagger();
            //啟用中間件服務生成Swagger,指定Swagger JSON終結點
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web App V1");
                c.RoutePrefix = string.Empty;//設置根節點訪問
            });
            app.UseMvc();
        }
    }
}

  然後,右鍵項目,點擊屬性。

  選擇生成,選擇我們的Debug路徑。

  勾選XML文檔文件,自動填充,然後會出現警告(非強迫症可以忽略警告)

  想要去掉警告,就在上面的取消顯示警告中加入上面顯示的1591,Ctrl+S保存一下,警告就沒了。

  然後點擊調試,將啟動瀏覽器後面url去掉。

  完成後,直接運行VS,就會進入文檔UI頁面了。

四、使用Swagger

  我們打開第一個方法,點擊Try it out按鈕。

  這個是無參的方法,直接點擊Execute執行。

  執行後可以看到Response body返回的內容。

  點擊第二個方法,給出兩個參數,輸入執行,得到返回結果。

  第三個方法的參數是model,要傳遞json格式的,預設已經生成好了,我們只需要編輯改一下值,再執行就行了。

五、總結

  到這裡.NET Core Api的簡單搭建和使用就告一段落了,此篇學到瞭如何創建.NET Core Api項目與怎麼搭建Swagger生成文檔及使用,接下來我會繼續學習和運用.NET Core Api,並將其過程記錄下來。本來想在這篇標題加個(一),但是想了想最近有可能更不了,等以後更了再加上吧。ㄟ( ▔, ▔ )ㄏ 


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

更多相關文章
  • 在 python 中,數字類型主要包括整數、浮點數和複數。 1.整數 整數用來表示整數數值,即沒有小數部分的數值。在 python 中,整數包括正整數、負整數和0,並且他的位數是任意的 整數類型包括十進位整數、八進位整數、十六進位整數和二進位整數 註意 不能以0作為十進位數的開頭(0除外)。 在 p ...
  • 某位 A 同學發了我一張截圖,問為何結果中出現了負數? 看了圖,我第一感覺就是數據溢出了。數據超出能表示的最大值,就會出現奇奇怪怪的結果。 然後,他繼續發了張圖,內容是 print(100000\ 208378),就是直接列印上圖的 E[0]\ G[0],結果是 20837800000,這是個正確的 ...
  • 因為重裝了系統,重新配置JDK環境變數,過程中遇到一些問題,分享一下。 本文圖片較多,適合新手 -- ( : 工具: Window 10 JDK1.8,官網或百度雲很好找 JDK1.8,官網或百度雲很好找 步驟: 一、安裝 單擊安裝包,進入以下界面: 直接點擊下一步。 直接點擊下一步。 安裝路徑建議 ...
  • 我不打算解釋什麼是 ,也不解釋為什麼要使用它。我希望你已經在其他地方瞭解過,如果沒有,你可以使用 去搜索它。在本文中,我將告訴您如何使用專門針對 和`RxJava`的響應式編程。讓我們開始吧。 1.預備知識 在你繼續閱讀之前,我希望你能理解如何使用 和`RxJava REST API`。 如果不能, ...
  • 上次在 asp.net core 從單機到集群 一文中提到存儲還不支持分散式,並立了一個 flag > 基於 github 或者 開源中國的碼雲實現一個 storage 於是這兩天就來填坑了。。 ...
  • 一、static關鍵字 下麵我設計了一個房貸利率上浮類(用來計算房貸利率上浮多少): 上面例子的問題在於基準利率這個屬性是所有房貸利率上浮對象共用的屬性,而不是每個房貸利率上浮對象都擁有一個基準利率。所以要把基準利率這個屬性設置成共用的需要使用static關鍵字,第二版房貸利率上浮類: 靜態自動屬性 ...
  • 在java的spring中有自動註入功能,使得代碼變得更加簡潔靈活,所以想把這個功能移植到c#中,接下來逐步分析實現過程 1.使用自動註入場景分析 在asp.net mvc中,無論是什麼代碼邏輯分層,最終的表現層為Controller層,所以我們註入點就是在Controller中,這裡我們需要替換默 ...
  • EF 6及以前的版本是預設支持延遲載入(Lazy Loading)的,早期的EF Core中並不支持,必須使用Include方法來支持導航屬性的數據載入。 當然在 EF Core 2.1 及之後版本中已經引入了延遲載入功能,詳細實現原理可以查看官網( "傳送門" )。 下麵記錄一下,分別使用Incl ...
一周排行
  • 該方式是直接對屏幕進行截圖操作UserControl chartContainPanel = new UserControl();Graphics graph = chartContainPanel.CreateGraphics();Size s = chartContainPanel.Size;B... ...
  • dotnetcore3.1 WPF 中使用依賴註入 Intro 在 ASP.NET Core 中預設就已經集成了依賴註入,最近把 "DbTool" 遷移到了 WPF dotnetcore 3.1, 在 WPF 中我們也希望能夠使用依賴註入,下麵來介紹一下如何在 WPF dotnetcore3.1 中 ...
  • 原來的C 程式都有Main的,現在用vs新建一個Wpf項目,啟動似乎變成App.xmal,前期項目中為了獲取啟動參數,很是折騰了一番: 1.先是修改App.xaml,添加StartUp事件 2.然後編輯Application_Startup,判斷e.Args數組 總感覺跟又臭又長的裹腳布一樣,不爽。 ...
  • 冒泡排序原理:(升序)通過當前位置數和後一個位置數進行比較 如果當前數比後一個數大 則交換位置, 完成後 比較基數的位置變成下一個數。直到數組末尾,當程式運行完第一遍 最大的數已經排序到最後一個位置了。次數可以減少迴圈數不用管最後一個數 降序排序同理 不過是把比較方式變成判斷當前數是否小於下一個數 ...
  • 一、前言 這方面的資料很多,重覆的寫沒必要,但是最近一直在學習身份驗證和授權相關東東,為了成體系還是寫一篇,主要是從概念上理解identity系統。 參考:https://www.cnblogs.com/r01cn/p/5179506.html 二、概述 幾乎所有系統都包含用戶、角色、許可權、登錄、註 ...
  • 首先我們使用最簡單的模板案例,裡面有一個Counter計數器,你可以在創建模板中找到。 首先需要設置運行調試方式為IIS Express。這意味著,MAC可能不能使用調試。 然後開啟運行而不調試(Ctrl+F5) 按Shift + Alt + D,會出現一個新的頁面。 如果你想用Chrome調試,復 ...
  • 實體映射時,遇到複雜類型,可選擇下述方法處理: NotMapped,跳過映射 在複雜類型上聲明 [Owned],但僅限該複雜類型是全部由簡單值類型組成的 自定義序列化方法 示例: IPInfo使用了owned,對IPEndPoint使用自定義序列化,對VersionInfo使用JSON序列化 @@@... ...
  • .NET Core 3 Web Api Cors fetch 一直 307 Temporary Redirect 繼上一篇 ".net core 3 web api jwt 一直 401" 為添加 所述的坑後, 本次為添加 ,又踩坑了。 自從 .NET Core 2.2 之後,CORS跨域配置代碼發 ...
  • 在前一章已經學習過WPF動畫的第一條規則——每個動畫依賴於一個依賴項屬性。然而,還有另一個限制。為了實現屬性的動態化(換句話說,使用基於時間的方式改變屬性的值),需要有支持相應數據類型的動畫類。例如,Button.Width屬性使用雙精度數據類型。為實現屬性的動態化,需要使用DoubleAnimat ...
  • WPF dotnet core 3.1 基於 `Microsoft.Extensions.Localization` 實現基本的多語言支持 ...
x