怎么在.NetCore中創(chuàng)建一個(gè)WebApi-創(chuàng)新互聯(lián)

這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)?lái)有關(guān)怎么在.Net Core中創(chuàng)建一個(gè)WebApi，文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述，閱讀完這篇文章希望大家可以有所收獲。

創(chuàng)新互聯(lián)建站2013年開(kāi)創(chuàng)至今，先為薩迦等服務(wù)建站，薩迦等地企業(yè)，進(jìn)行企業(yè)商務(wù)咨詢服務(wù)。為薩迦企業(yè)網(wǎng)站制作PC+手機(jī)+微官網(wǎng)三網(wǎng)同步一站式服務(wù)解決您的所有建站問(wèn)題。

一、創(chuàng)建項(xiàng)目

打開(kāi)VS2019，新建一個(gè)ASP.NET Core Web 應(yīng)用程序。

輸入項(xiàng)目名、選擇路徑創(chuàng)建。

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

創(chuàng)建的項(xiàng)目目錄內(nèi)容如下。

二、編輯控制器

打開(kāi)Controllers文件夾，這里我直接使用默認(rèn)創(chuàng)建的ValuesController控制器。（其實(shí)是因?yàn)檫@是個(gè)例子我懶的再建了(￣.￣)）

ValuesController控制器默認(rèn)內(nèi)容如下。共有四個(gè)HTTP方法，分別為 Get、Post、Put 和 Delete。

把該控制器的內(nèi)容重新寫(xiě)一下，將路由設(shè)置為api/控制器/方法（api/[controller]/[action]）。按照常用Get 和 Post兩個(gè)請(qǐng)求，寫(xiě)了兩個(gè)Get方法和一個(gè)Post方法，一個(gè)參數(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">第一個(gè)數(shù)</param>
    /// <param name="num2">第二個(gè)數(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>
    /// 第一個(gè)數(shù)
    /// </summary>
    public int num1 { get; set; }
    /// <summary>
    /// 第二個(gè)數(shù)
    /// </summary>
    public int num2 { get; set; }
  }
}

然后右鍵項(xiàng)目→屬性→調(diào)試，將啟動(dòng)瀏覽器默認(rèn)指向?yàn)榈谝粋€(gè)Get方法。

調(diào)試運(yùn)行，訪問(wèn)第一個(gè)方法，返回結(jié)果。

訪問(wèn)第二個(gè)方法加上參數(shù)，得到結(jié)果。

第三個(gè)方法是Post請(qǐng)求，無(wú)法直接輸入，可以用其他方式實(shí)現(xiàn)。

三、搭建Swagger

這樣WebApi 就簡(jiǎn)單實(shí)現(xiàn)了，不過(guò)這樣不容易管理。為了更好的管理和測(cè)試我們的接口，我這里使用了Swagger框架。

Swagger是什么？Swagger 是一個(gè)規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化RESTful風(fēng)格的 Web 服務(wù)。

右鍵項(xiàng)目，點(diǎn)擊管理NuGet程序包。

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

安裝完成之后，編輯Startup.cs文件。

引用下面三個(gè)命名空間。

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">第一個(gè)數(shù)</param>
    /// <param name="num2">第二個(gè)數(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>
    /// 第一個(gè)數(shù)
    /// </summary>
    public int num1 { get; set; }
    /// <summary>
    /// 第二個(gè)數(shù)
    /// </summary>
    public int num2 { get; set; }
  }
}

在ConfigureServices方法里加入下面的代碼，注冊(cè)Swagger生成器，定義一個(gè)文檔，設(shè)置xml文檔的注釋路徑，。

//配置Swagger
//注冊(cè)Swagger生成器，定義一個(gè)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é)點(diǎn)（http://localhost:port）直接顯示SwaggerUI界面。

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

編輯后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
      //注冊(cè)Swagger生成器，定義一個(gè)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é)點(diǎn)
      app.UseSwaggerUI(c =>
      {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web App V1");
        c.RoutePrefix = string.Empty;//設(shè)置根節(jié)點(diǎn)訪問(wèn)
      });
      app.UseMvc();
    }
  }
}

然后，右鍵項(xiàng)目，點(diǎn)擊屬性。

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

勾選XML文檔文件，自動(dòng)填充，然后會(huì)出現(xiàn)警告（非強(qiáng)迫癥可以忽略警告）

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

然后點(diǎn)擊調(diào)試，將啟動(dòng)瀏覽器后面url去掉。

完成后，直接運(yùn)行VS，就會(huì)進(jìn)入文檔UI頁(yè)面了。

四、使用Swagger

我們打開(kāi)第一個(gè)方法，點(diǎn)擊Try it out按鈕。

這個(gè)是無(wú)參的方法，直接點(diǎn)擊Execute執(zhí)行。

執(zhí)行后可以看到Response body返回的內(nèi)容。

點(diǎn)擊第二個(gè)方法，給出兩個(gè)參數(shù)，輸入執(zhí)行，得到返回結(jié)果。

第三個(gè)方法的參數(shù)是model，要傳遞json格式的，默認(rèn)已經(jīng)生成好了，我們只需要編輯改一下值，再執(zhí)行就行了。

上述就是小編為大家分享的怎么在.Net Core中創(chuàng)建一個(gè)WebApi了，如果剛好有類似的疑惑，不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識(shí)，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。

當(dāng)前標(biāo)題：怎么在.NetCore中創(chuàng)建一個(gè)WebApi-創(chuàng)新互聯(lián)
URL標(biāo)題：http://muchs.cn/article12/hehdc.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供移動(dòng)網(wǎng)站建設(shè)、網(wǎng)站制作、網(wǎng)站內(nèi)鏈、網(wǎng)站設(shè)計(jì)公司、Google、自適應(yīng)網(wǎng)站

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源： 創(chuàng)新互聯(lián)