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

標籤：.NET Core

上一篇：IdentityServer4 4.x版本 配置Scope的正確姿勢

下一篇：干！垃圾微軟！發布我的Netcore跨平臺UI框架 CPF