溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務(wù)條款》

用vs2019加.net core如何創(chuàng)建WeiApi項目

發(fā)布時間:2020-07-06 14:06:29 來源:億速云 閱讀:897 作者:清晨 欄目:開發(fā)技術(shù)

這篇文章將為大家詳細(xì)講解有關(guān)用vs2019加.net core如何創(chuàng)建WeiApi項目,小編覺得挺實用的,因此分享給大家做個參考,希望大家閱讀完這篇文章后可以有所收獲。

vs2019創(chuàng)建webapi

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

用vs2019加.net core如何創(chuàng)建WeiApi項目

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

用vs2019加.net core如何創(chuàng)建WeiApi項目

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

用vs2019加.net core如何創(chuàng)建WeiApi項目

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

用vs2019加.net core如何創(chuàng)建WeiApi項目

5.刪除原本的無用的類

用vs2019加.net core如何創(chuàng)建WeiApi項目

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
  {


  }
}

用vs2019加.net core如何創(chuàng)建WeiApi項目

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)試

用vs2019加.net core如何創(chuàng)建WeiApi項目

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

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

用vs2019加.net core如何創(chuàng)建WeiApi項目

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

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

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

用vs2019加.net core如何創(chuàng)建WeiApi項目

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

用vs2019加.net core如何創(chuàng)建WeiApi項目

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

用vs2019加.net core如何創(chuàng)建WeiApi項目

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

用vs2019加.net core如何創(chuàng)建WeiApi項目

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

用vs2019加.net core如何創(chuàng)建WeiApi項目

6.直接啟動

用vs2019加.net core如何創(chuàng)建WeiApi項目

關(guān)于用vs2019加.net core如何創(chuàng)建WeiApi項目就分享到這里了,希望以上內(nèi)容可以對大家有一定的幫助,可以學(xué)到更多知識。如果覺得文章不錯,可以把它分享出去讓更多的人看到。

向AI問一下細(xì)節(jié)

免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI