使用vs2019加.net core 對WeiApi的創建

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.直接啟動