.Net Core WebApi的簡單創建以及使用方法

 更新時間:2020-01-15 16:00:36   作者:佚名   我要評論(0)

前言
按照目前的軟件開發發展趨勢中,不管是前后端分離還是提供數據服務,WebApi使用的越來越廣泛,而且.NET Core也是我們.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;
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; }
  }
}

在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,并將其過程記錄下來。本來想在這篇標題加個(一),但是想了想最近有可能更不了,等以后更了再加上吧。ㄟ( ▔, ▔ )ㄏ

好了,以上就是這篇文章的全部內容了,希望本文的內容對大家的學習或者工作具有一定的參考學習價值,謝謝大家對腳本之家的支持。

您可能感興趣的文章:

  • ASP.NET Core 2.0 WebApi全局配置及日志實例
  • 淺談ASP.Net Core WebApi幾種版本控制對比
  • asp.net core 2.0 webapi集成signalr(實例講解)
  • .Net Core2.1 WebAPI新增Swagger插件詳解
  • asp.net core webapi項目配置全局路由的方法示例
  • asp.net core webapi 服務端配置跨域的實例
  • 詳解.net core webapi 前后端開發分離后的配置和部署
  • ASP.NET Core MVC/WebApi基礎系列2
  • ASP.NET Core MVC/WebApi基礎系列1

相關文章

  • .Net Core WebApi的簡單創建以及使用方法

    .Net Core WebApi的簡單創建以及使用方法

    前言 按照目前的軟件開發發展趨勢中,不管是前后端分離還是提供數據服務,WebApi使用的越來越廣泛,而且.NET Core也是我們.NET開發人員未來發展的趨勢,所以說學會使
    2020-01-15
  • .Net Core實現健康檢查的示例代碼

    .Net Core實現健康檢查的示例代碼

    ASP.NET Core 提供運行狀況檢查中間件和庫,以用于報告應用基礎結構組件的運行狀況。 運行狀況檢查由應用程序作為 HTTP 終結點公開。 可以為各種實時監視方案配置運
    2020-01-15
  • 詳解在ASP.NET Core中如何編寫合格的中間件

    詳解在ASP.NET Core中如何編寫合格的中間件

    這篇文章探討了讓不同的請求去使用不同的中間件,那么我們應該如何配置ASP.NET Core中間件?其實中間件只是在ASP.NET Core中處理Web請求的管道。所有ASP.NET Core應
    2020-01-15
  • .NET 開發環境搭建圖文詳解

    .NET 開發環境搭建圖文詳解

    1 概述 在接下來的時間里,將會入手ASP.NET MVC這一專題,盡量用最快的時間,最有效的方法,分別從深度和廣度上剖析這一專題,力求講明白、講透。以此來與大家分享,
    2020-01-15
  • .NET Core 實現微信小程序支付功能(統一下單)

    .NET Core 實現微信小程序支付功能(統一下單)

    最近公司研發了幾個電商小程序,還有一個核心的電商直播,只要是電商一般都會涉及到交易信息,離不開支付系統,這里我們統一實現小程序的支付流程(與服務號實現步驟
    2020-01-15
  • 利用.net core實現反向代理中間件的方法

    利用.net core實現反向代理中間件的方法

    最近在將一些項目的rest api遷移到.net core中,最開始是用的Nginx做反向代理,將已經完成切換的部分切入系統,如下圖所示: 由于遷移過程中也在進行代碼重構,需要
    2020-01-15
  • ASP.NET MVC實現依賴注入的完整過程

    ASP.NET MVC實現依賴注入的完整過程

    前言 在java的spring中有自動注入功能,使得代碼變得更加簡潔靈活,所以想把這個功能移植到c#中,接下來逐步分析實現過程 1.使用自動注入場景分析 在asp.net mvc中,
    2020-01-15
  • .NET資源泄露與處理方案知識點分享

    .NET資源泄露與處理方案知識點分享

    .NET雖然擁有強大易用的垃圾回收機制,但并不是因為這樣,你就可以對資源管理放任不管,其實在稍不注意的時候,可能就造成了資源泄露,甚至因此導致系統崩潰,到那時
    2020-01-15
  • asp.net大文件上傳解決方案實例代碼

    asp.net大文件上傳解決方案實例代碼

    以ASP.NET Core WebAPI 作后端 API ,用 Vue 構建前端頁面,用 Axios 從前端訪問后端 API ,包括文件的上傳和下載。 準備文件上傳的API #region 文件上傳 可以帶參
    2020-01-15
  • .Net Core讀取Json配置文件的實現示例

    .Net Core讀取Json配置文件的實現示例

    前言:在與傳統的asp.net MVC項目相比,.net core項目在項目目錄的文件結構上和功能上與前者都有很大的區別。例如:在.net core中使用Startup.cs取代Global.asax文件
    2020-01-15

最新評論

老快3投注技巧 股票基本入门知识 老师带散户炒股骗局 广西11选5app 梦之城之娱乐 3.10股票推荐 青海十一选五平台 湖北快三大小玩法 在线配资 杨方配资 云南十一选五开奖号码 连线天津时时彩走势图 山西体彩新11选五的规则 000793股票行情 安徽十一选五 炒股最低需要多少钱 北京赛车开奖视频 河南福彩快三基本走势图