使用vs2019加.net core 對WeiApi的創(chuàng)建過程詳解

更新時間：2020年07月03日 11:25:17 作者：BIN_Coisini

這篇文章主要介紹了使用vs2019加.net core 對WeiApi的創(chuàng)建,本文通過圖文并茂的形式給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

vs2019創(chuàng)建webapi

1.創(chuàng)建新的項目

2.選擇.NET CORE的ASP .NET CORE WEB應(yīng)用程序

3.定義項目名稱和存放地點

4.選擇API創(chuàng)建項目

5.刪除原本的無用的類

6.添加新的方法類

7.設(shè)置路由

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

namespace WEBAPI.Controllers
{

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


  }
}

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

我們分別創(chuàng)建一個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>
  /// 設(shè)置路由
  /// </summary>
  [Route("api/[controller]/[action]")]
  [ApiController]
  public class Calculation
  {

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

9.開始調(diào)試

在調(diào)試中修改路徑為api/Calculation/get

開始運行,結(jié)果為

別的方法自行加參數(shù)修改

為了方便對api接口進行管理和調(diào)試,我使用了Swagger框架。為了更好地可視化運行我的接口

1.為項目添加NuGet包　　　　Swashbuckle.AspNetCore

2.在Startup的ConfigureServices方法里加入下面的代碼，注冊Swagger生成器，定義一個文檔，設(shè)置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 設(shè)置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方法里加入下面的代碼，啟用

中間件服務(wù)使用生成Swagger和SwaggerUI

//啟用中間件服務(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();

4.然后右擊項目繼續(xù)選擇屬性,在生成中選擇輸出路徑

并且勾選xml文檔

5.清空調(diào)試的路徑

6.直接啟動

到此這篇關(guān)于使用vs2019加.net core 對WeiApi的創(chuàng)建過程詳解的文章就介紹到這了,更多相關(guān)vs2019加.net core 對WeiApi的創(chuàng)建內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: