vs2019建立webapi

1.建立新的專案

2.選擇.NET CORE的ASP .NET CORE WEB應用程式

3.定義專案名稱和存放地點

4.選擇API建立專案

5.刪除原本的無用的類

6.新增新的方法類

7.設定路由

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

namespace WEBAPI.Controllers
{

  /// <summary>
  /// 設定路由
  /// </summary>
  [Route("api/[controller]/[action]")]
  public class Calculation
  {


  }
}

8.下面開始寫你所需要的介面方法

我們分別建立一個post兩個get的方法

方法如下

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

namespace WEBAPI.Controllers
{

  /// <summary>
  /// 設定路由
  /// </summary>
  [Route("api/[controller]/[action]")]
  [ApiController]
  public class Calculation
  {

    /// <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; }
  }
}

9.開始除錯

在除錯中修改路徑為api/Calculation/get

開始執行,結果為

別的方法自行加引數修改

為了方便對api介面進行管理和除錯,我使用了Swagger框架。為了更好地視覺化執行我的介面

1.為專案新增NuGet包　　　　Swashbuckle.AspNetCore

2.在Startup的ConfigureServices方法里加入下面的程式碼，註冊Swagger生成器，定義一個文件，設定xml文件的註釋路徑

services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
      //配置Swagger
      //註冊Swagger生成器，定義一個Swagger 文件
      services.AddSwaggerGen(c =>
      {
        c.SwaggerDoc("v1",new OpenApiInfo
        {
          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);
      });
      services.AddMvc(x => x.EnableEndpointRouting = false);

3.在Configure方法里加入下面的程式碼，啟用

中介軟體服務使用生成Swagger和SwaggerUI

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

4.然後右擊專案繼續選擇屬性,在生成中選擇輸出路徑

並且勾選xml文件

5.清空除錯的路徑

6.直接啟動

到此這篇關於使用vs2019加.net core 對WeiApi的建立過程詳解的文章就介紹到這了,更多相關vs2019加.net core 對WeiApi的建立內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！