.Net8?WebAPI項目創(chuàng)建部署的實現
本著學新不學舊的原則,.Net Core會逐步替代.Net Framework,并且是開源框架,能用在什么地方懂的都懂。本文記錄了Net8框架下的Web API項目創(chuàng)建到部署過程。
1、創(chuàng)建項目
新建項目選擇ASP.NET Core Web API,太多了的話可以在上面篩選
如果沒有去VS Installer添加“ASP.NET 和 Web開發(fā)”模塊并安裝。
配置項目
配置HTTPS:方便測試不勾選。
不使用頂級語句:勾選后是傳統(tǒng)的Program類中定義Main函數入口;不勾選直接就是指令有點抽象不符合C#習慣,夠不夠選看個人。
使用控制器:不勾選會在Program中寫方法,看著亂,建議勾選。
2、項目結構和解釋
項目結構
Main函數配置解釋:
namespace WebAPI記錄 { public class Program { public static void Main(string[] args) { var builder = WebApplication.CreateBuilder(args); // Add services to the container. builder.Services.AddControllers(); //注入swagger // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle builder.Services.AddEndpointsApiExplorer(); //生成文檔 builder.Services.AddSwaggerGen(); //設置文檔內容 var app = builder.Build(); // Configure the HTTP request pipeline. if (app.Environment.IsDevelopment()) //只有當程序處于debug的情況才開啟swagger { //分別注入中間件和ui中間間 app.UseSwagger(); app.UseSwaggerUI(); } app.UseAuthorization(); app.MapControllers(); app.Run(); } } }
Controller解釋:
using Microsoft.AspNetCore.Mvc; namespace WebAPI記錄.Controllers { [ApiController] [Route("[controller]")] public class WeatherForecastController : ControllerBase { private static readonly string[] Summaries = new[] { "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" }; private readonly ILogger<WeatherForecastController> _logger; public WeatherForecastController(ILogger<WeatherForecastController> logger) { _logger = logger; } // http://ip:port/WeatherForecast [HttpGet(Name = "GetWeatherForecast")] // 創(chuàng)建Get請求 public IEnumerable<WeatherForecast> Get() { return Enumerable.Range(1, 5).Select(index => new WeatherForecast { Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)), TemperatureC = Random.Shared.Next(-20, 55), Summary = Summaries[Random.Shared.Next(Summaries.Length)] }) .ToArray(); } } } .ToArray(); } } }
LaunchSettings.json配置文件:
記錄了端口配置信息等。
{ "$schema": "http://json.schemastore.org/launchsettings.json", "iisSettings": { "windowsAuthentication": false, "anonymousAuthentication": true, "iisExpress": { "applicationUrl": "http://localhost:12692", "sslPort": 0 } }, "profiles": { "http": { "commandName": "Project", "dotnetRunMessages": true, "launchBrowser": true, "launchUrl": "swagger", "applicationUrl": "http://localhost:5053", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } }, "IIS Express": { "commandName": "IISExpress", "launchBrowser": true, "launchUrl": "swagger", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } } } }
3、本地運行
可以選擇http或者IIS方式運行,端口見上面json內的配置
運行效果
Debug模式下會進入Swagger頁面(見上面Main函數注釋),以UI形式方便觀察測試接口和結果
點擊Execute查看請求URL和返回結果
至此本地測試完成
4、生成項目
選擇菜單欄中的 生成 -> 發(fā)布。
目標可以選文件夾,簡單一點
默認路徑是生成文件夾下的publish目錄
點擊發(fā)布編譯生成項目
生成成功后可以直接到生成目錄下:
5、服務器遠程部署(Windows)
部署環(huán)境:Window Server 2016
(1)安裝IIS
這邊簡單寫了,詳細自行查詢
服務器管理器 -> 添加功能 -> 安裝IIS
(2)安裝NetCore運行時
進入微軟官網下載運行時Download .NET 8.0 (Linux, macOS, and Windows),選擇HostBundle包即可。
安裝完后,右鍵找到IIS管理器:
在模塊下出現AspNetCoreModuleV2表示安裝成功:
(3)配置IIS
添加應用程序池:
輸入名稱,選擇”無托管代碼“:
將發(fā)布生成的文件夾傳到服務器上去,過程略。
IIS添加網站:
應用程序池選擇剛才創(chuàng)建的
物理路徑選擇剛才上傳的文件夾
綁定的端口選擇空端口(不用和項目中json配置的一樣)
編輯權限中創(chuàng)建一個完全控制權限的賬戶
點擊”啟動“運行,發(fā)現什么都沒有。別忘記我們做的是API不是網站,地址換成接口URL就有了
Postman遠程測試也沒有問題:
6、新增自定義接口
Controllers文件夾添加控制器
命名方式注意以Controller結尾
創(chuàng)建好后代碼自動繼承Controller。
[Route(“[controller]”)]
表示URL以類名MyAPI為路由地址,希望其他地址直接改字符串就行。
列舉了4個請求的例子:
using Microsoft.AspNetCore.Mvc; namespace WebAPI記錄.Controllers { [ApiController] [Route("[controller]")] public class MyAPIController : Controller { // http://ip:port [HttpGet] public string GetString() { return "Hello"; } // http://ip:port/myapi/id [HttpGet("id")] public string GetStringByID([FromHeader]int id) // FromHeader屬性表示從請求頭獲得參數 { return "Hello " + id.ToString(); } // http://ip:port/myapi/result [HttpGet("result")] public IActionResult GetStringResult() { var data = new { Message = "Hello" }; return Ok(data); // Ok返回包含請求數據的HTTP 200 } // http://ip:port/postdata [HttpPost("postdata")] public IActionResult PostData([FromBody] DataModel data) // FromBody屬性表示從請求的Body中讀取并轉為DataModel類 { // 在這里處理接收到的數據 return CreatedAtAction(nameof(PostData), null, new { Message = data }); // CreatedAtAction返回包含創(chuàng)建資源的 URL 的 HTTP 201 響應 } } }
DataModel類:
namespace WebAPI記錄 { public class DataModel { public string Name { get; set; } public int Value { get; set; } } }
運行后已經可以訪問結果了
測試結果:
到此這篇關于.Net8 WebAPI項目創(chuàng)建部署的實現的文章就介紹到這了,更多相關.Net8 WebAPI創(chuàng)建部署內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
基于.Net中的數字與日期格式化規(guī)則助記詞的使用詳解
本篇文章是對.Net中的數字與日期格式化規(guī)則助記詞的使用進行了詳細的分析介紹,需要的朋友參考下2013-05-05Asp.Net Couchbase Memcached圖文安裝調用開發(fā)
本文主要是是如何安裝CouchBase服務端,以及客戶端如何進行調用。圖文詳解,大家參考吧2013-11-11