.Net Core WebApi的簡單創(chuàng)建以及使用方法
前言
按照目前的軟件開發(fā)發(fā)展趨勢中，不管是前后端分離還是提供數(shù)據(jù)服務(wù)，WebApi使用的越來越廣泛，而且.NET Core也是我們.NET開發(fā)人員未來發(fā)展的趨勢，所以說學(xué)會使用.NET Core Api是非常有必要的。
本人作為一個.NET菜鳥，正在慢慢的學(xué)習(xí)中，將學(xué)到的一步一步記錄下來。
一、創(chuàng)建項目
打開VS2019，新建一個ASP.NET Core Web 應(yīng)用程序。
輸入項目名、選擇路徑創(chuàng)建。
選擇.NET Core 我這里用的是.NET Core 2.2版本，選中API，把右邊的選中取消。
創(chuàng)建的項目目錄內(nèi)容如下。
二、編輯控制器
打開Controllers文件夾，這里我直接使用默認(rèn)創(chuàng)建的ValuesController控制器。（其實是因為這是個例子我懶的再建了(￣.￣)）
ValuesController控制器默認(rèn)內(nèi)容如下。共有四個HTTP方法，分別為 Get、Post、Put 和 Delete。
把該控制器的內(nèi)容重新寫一下，將路由設(shè)置為api/控制器/方法（api/[controller]/[action]）。按照常用Get 和 Post兩個請求，寫了兩個Get方法和一個Post方法，一個參數(shù)類。
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
namespace FirstApi.Controllers
{
//路由設(shè)置
[Route("api/[controller]/[action]")]
[ApiController]
public class ValuesController : ControllerBase
{
/// <summary>
/// 獲取文本
/// </summary>
/// <returns></returns>
[HttpGet]
public ActionResult<string> Get()
{
return "Hello World!";
}
/// <summary>
/// 兩數(shù)相加
/// </summary>
/// <param name="num1">第一個數(shù)</param>
/// <param name="num2">第二個數(shù)</param>
/// <returns></returns>
[HttpGet]
public ActionResult<int> Sum(int num1,int num2)
{
return num1 + num2;
}
/// <summary>
/// 兩數(shù)相減
/// </summary>
/// <param name="param">參數(shù)</param>
/// <returns></returns>
[HttpPost]
public ActionResult<int> Subtract(Param param)
{
int result = param.num1 - param.num2;
return result;
}
}
/// <summary>
/// 參數(shù)
/// </summary>
public class Param
{
/// <summary>
/// 第一個數(shù)
/// </summary>
public int num1 { get; set; }
/// <summary>
/// 第二個數(shù)
/// </summary>
public int num2 { get; set; }
}
}
然后右鍵項目→屬性→調(diào)試，將啟動瀏覽器默認(rèn)指向為第一個Get方法。
調(diào)試運行，訪問第一個方法，返回結(jié)果。
訪問第二個方法加上參數(shù)，得到結(jié)果。
第三個方法是Post請求，無法直接輸入，可以用其他方式實現(xiàn)。
三、搭建Swagger
這樣WebApi 就簡單實現(xiàn)了，不過這樣不容易管理。為了更好的管理和測試我們的接口，我這里使用了Swagger框架。
Swagger是什么？Swagger 是一個規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化RESTful風(fēng)格的 Web 服務(wù)。
右鍵項目，點擊管理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
{
//路由設(shè)置
[Route("api/[controller]/[action]")]
[ApiController]
public class ValuesController : ControllerBase
{
/// <summary>
/// 獲取文本
/// </summary>
/// <returns></returns>
[HttpGet]
public ActionResult<string> Get()
{
return "Hello World!";
}
/// <summary>
/// 兩數(shù)相加
/// </summary>
/// <param name="num1">第一個數(shù)</param>
/// <param name="num2">第二個數(shù)</param>
/// <returns></returns>
[HttpGet]
public ActionResult<int> Sum(int num1,int num2)
{
return num1 + num2;
}
/// <summary>
/// 兩數(shù)相減
/// </summary>
/// <param name="param">參數(shù)</param>
/// <returns></returns>
[HttpPost]
public ActionResult<int> Subtract(Param param)
{
int result = param.num1 - param.num2;
return result;
}
}
/// <summary>
/// 參數(shù)
/// </summary>
public class Param
{
/// <summary>
/// 第一個數(shù)
/// </summary>
public int num1 { get; set; }
/// <summary>
/// 第二個數(shù)
/// </summary>
public int num2 { get; set; }
}
}
在ConfigureServices方法里加入下面的代碼，注冊Swagger生成器，定義一個文檔，設(shè)置xml文檔的注釋路徑，。
//配置Swagger
//注冊Swagger生成器，定義一個Swagger 文檔
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info
{
Version = "v1",
Title = "接口文檔",
Description = "RESTful API"
});
// 為 Swagger 設(shè)置xml文檔注釋路徑
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
c.IncludeXmlComments(xmlPath);
});
在Configure方法里加入下面的代碼，啟用中間件服務(wù)使用生成Swagger和SwaggerUI，將SwaggerUI中的RoutePrefix設(shè)為空字符串，這樣就能在根節(jié)點（http://localhost:port）直接顯示SwaggerUI界面。
//啟用中間件服務(wù)生成Swagger
app.UseSwagger();
//啟用中間件服務(wù)生成SwaggerUI，指定Swagger JSON終結(jié)點
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web App V1");
c.RoutePrefix = string.Empty;//設(shè)置根節(jié)點訪問
});
編輯后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 設(shè)置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();
}
//啟用中間件服務(wù)生成Swagger
app.UseSwagger();
//啟用中間件服務(wù)生成Swagger，指定Swagger JSON終結(jié)點
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web App V1");
c.RoutePrefix = string.Empty;//設(shè)置根節(jié)點訪問
});
app.UseMvc();
}
}
}
然后，右鍵項目，點擊屬性。
選擇生成，選擇我們的Debug路徑。
勾選XML文檔文件，自動填充，然后會出現(xiàn)警告（非強迫癥可以忽略警告）
想要去掉警告，就在上面的取消顯示警告中加入上面顯示的1591，Ctrl+S保存一下，警告就沒了。
然后點擊調(diào)試，將啟動瀏覽器后面url去掉。
完成后，直接運行VS，就會進入文檔UI頁面了。
四、使用Swagger
我們打開第一個方法，點擊Try it out按鈕。
這個是無參的方法，直接點擊Execute執(zhí)行。
執(zhí)行后可以看到Response body返回的內(nèi)容。
點擊第二個方法，給出兩個參數(shù)，輸入執(zhí)行，得到返回結(jié)果。
第三個方法的參數(shù)是model，要傳遞json格式的，默認(rèn)已經(jīng)生成好了，我們只需要編輯改一下值，再執(zhí)行就行了。
五、總結(jié)
到這里.NET Core Api的簡單搭建和使用就告一段落了，此篇學(xué)到了如何創(chuàng)建.NET Core Api項目與怎么搭建Swagger生成文檔及使用，接下來我會繼續(xù)學(xué)習(xí)和運用.NET Core Api，并將其過程記錄下來。本來想在這篇標(biāo)題加個（一），但是想了想最近有可能更不了，等以后更了再加上吧。ㄟ( ▔, ▔ )ㄏ
好了，以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，謝謝大家對腳本之家的支持。
相關(guān)文章
asp.net頁面與頁面之間傳參數(shù)值方法(post傳值和get傳值)
這篇文章主要介紹了asp.net頁面與頁面之間傳參數(shù)值方法，說明了post傳值和get傳值的使用方法,需要的朋友可以參考下2014-02-02
asp.net實現(xiàn)訪問局域網(wǎng)共享目錄下文件的解決方法
這篇文章主要介紹了asp.net實現(xiàn)訪問局域網(wǎng)共享目錄下文件的解決方法,需要的朋友可以參考下2014-07-07
.Net中關(guān)于stirng轉(zhuǎn)System.Type的一種實現(xiàn)思路詳解
這篇文章主要給大家介紹了.Net中關(guān)于stirng轉(zhuǎn)System.Type的一種實現(xiàn)思路的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2018-05-05
2個頁面間不通過Session與url的傳值方式...2006-09-09
C#反射技術(shù)的簡單操作(讀取和設(shè)置類的屬性)
反射的作用想必大家都知道了吧，少量屬性的自動化操作手動添加幾下當(dāng)然是沒有問題的，但是屬性數(shù)量較多的時候敲起這些繁鎖的代碼可以困了，再說對擴展和維護性造成很多的不遍，以下代碼中如不能直接使用請?zhí)砑觰sing System.Text;的引用。2011-01-01
NLog是一個免費的日志記錄框架，專門為.net平臺下的框架提供日志功能，下面這篇文章主要給大家介紹了關(guān)于ASP.NET Core與NLog集成的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，需要的朋友可以參考下2018-07-07
ASP.NET操作Word的IIS權(quán)限設(shè)置
檢索 COM 類工廠中 CLSID 為 {00024500-0000-0000-C000-000000000046} 的組件時失敗，原因是出現(xiàn)以下錯誤: 80070005。2011-02-02
asp.net中js+jquery添加下拉框值和后臺獲取示例
這篇文章主要介紹了asp.net中js+jquery添加下拉框值和后臺獲取的具體實現(xiàn),需要的朋友可以參考下2014-05-05
ASP.NET MVC驗證碼功能實現(xiàn)代碼，需要的朋友可以參考一下2013-06-06
asp.net下結(jié)合HttpHandler實現(xiàn)圖片防盜鏈
asp.net防圖片盜鏈HttpHandler2010-07-07