.Net8 WebAPI项目创建部署的实现

旭翔汽车蓄电池 發表於 2025-5-8 09:36:46

<div id="navCategory"><h5 class="catalogue">目录</h5><ul class="first_class_ul"><li><a href="#_label0">1、创建项目</a></li><li><a href="#_label1">2、项目结构和解释</a></li><li><a href="#_label2">3、本地运行</a></li><li><a href="#_label3">4、生成项目</a></li><li><a href="#_label4">5、服务器远程部署（Windows）</a></li><ul class="second_class_ul"><li><a href="#_lab2_4_0">（1）安装IIS</a></li><li><a href="#_lab2_4_1">（2）安装NetCore运行时</a></li><li><a href="#_lab2_4_2">（3）配置IIS</a></li></ul><li><a href="#_label5">6、新增自定义接口</a></li><ul class="second_class_ul"></ul></ul></div>本着学新不学旧的原则，.Net Core会逐步替代.Net Framework，并且是开源框架，能用在什么地方懂的都懂。本文记录了Net8框架下的Web API项目创建到部署过程。
<a name="_label0"></a><h2>1、创建项目</h2>
新建项目选择ASP.NET Core Web API，太多了的话可以在上面筛选
如果没有去VS Installer添加“ASP.NET 和 Web开发”模块并安装。
<img alt="安装" src="https://img.jbzj.com/file_images/article/202505/202505080930131.png" />
<img alt="创建项目" src="https://img.jbzj.com/file_images/article/202505/202505080930132.png" />
配置项目
<blockquote>配置HTTPS：方便测试不勾选。 不使用顶级语句：勾选后是传统的Program类中定义Main函数入口；不勾选直接就是指令有点抽象不符合C#习惯，够不够选看个人。 使用控制器：不勾选会在Program中写方法，看着乱，建议勾选。</blockquote>
<img alt="项目配置" src="https://img.jbzj.com/file_images/article/202505/202505080930133.png" />
<a name="_label1"></a><h2>2、项目结构和解释</h2>
项目结构
<img alt="项目结构" src="https://img.jbzj.com/file_images/article/202505/202505080930134.png" />
Main函数配置解释：
<div class="jb51code"><pre class="brush:csharp;">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();
 }
}
}
</pre></div>
Controller解释：
<div class="jb51code"><pre class="brush:csharp;">using Microsoft.AspNetCore.Mvc;

namespace WebAPI记录.Controllers
{

")]
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
 // 创建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
 })
 .ToArray();
 }
}
}
.ToArray();
 }
}
}
</pre></div>
LaunchSettings.json配置文件：
记录了端口配置信息等。
<div class="jb51code"><pre class="brush: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"
 }
}
}
}
</pre></div>
<a name="_label2"></a><h2>3、本地运行</h2>
可以选择http或者IIS方式运行，端口见上面json内的配置
<img alt="运行方式" src="https://img.jbzj.com/file_images/article/202505/202505080930135.png" />
运行效果
Debug模式下会进入Swagger页面（见上面Main函数注释），以UI形式方便观察测试接口和结果
<img alt="Swagger" src="https://img.jbzj.com/file_images/article/202505/202505080930146.png" />
<img alt="Swagger" src="https://img.jbzj.com/file_images/article/202505/202505080930147.png" />
点击Execute查看请求URL和返回结果
<img alt="本地测试" src="https://img.jbzj.com/file_images/article/202505/202505080930148.png" />
至此本地测试完成
<a name="_label3"></a><h2>4、生成项目</h2>
选择菜单栏中的生成 -> 发布。
目标可以选文件夹，简单一点
<img alt="发布" src="https://img.jbzj.com/file_images/article/202505/202505080930149.png" />
默认路径是生成文件夹下的publish目录
<img alt="发布" src="https://img.jbzj.com/file_images/article/202505/2025050809301410.png" />
点击发布编译生成项目
<img alt="发布" src="https://img.jbzj.com/file_images/article/202505/2025050809301411.png" />
<img alt="编译" src="https://img.jbzj.com/file_images/article/202505/2025050809301412.png" />
生成成功后可以直接到生成目录下：
<img alt="生成" src="https://img.jbzj.com/file_images/article/202505/2025050809301413.png" />
<a name="_label4"></a><h2>5、服务器远程部署（Windows）</h2>
部署环境：Window Server 2016
<a name="_lab2_4_0"></a><h3>（1）安装IIS</h3>
这边简单写了，详细自行查询
服务器管理器 -> 添加功能 -> 安装IIS
<a name="_lab2_4_1"></a><h3>（2）安装NetCore运行时</h3>
进入微软官网下载运行时<a href="https://dotnet.microsoft.com/zh-cn/download/dotnet/8.0" rel="external nofollow" target="_blank">Download .NET 8.0 (Linux, macOS, and Windows)</a>，选择HostBundle包即可。
<img alt="NETCore" src="https://img.jbzj.com/file_images/article/202505/2025050809301414.png" />
安装完后，右键找到IIS管理器：
<img alt="IIS" src="https://img.jbzj.com/file_images/article/202505/2025050809301415.png" />
在模块下出现AspNetCoreModuleV2表示安装成功：
<img alt="在这里插入图片描述" src="https://img.jbzj.com/file_images/article/202505/2025050809301416.png" />
<img alt="在这里插入图片描述" src="https://img.jbzj.com/file_images/article/202505/2025050809301517.png" />
<a name="_lab2_4_2"></a><h3>（3）配置IIS</h3>
添加应用程序池：
<img alt="应用程序池" src="https://img.jbzj.com/file_images/article/202505/2025050809301518.png" />
输入名称，选择”无托管代码“：
<img alt="应用程序池" src="https://img.jbzj.com/file_images/article/202505/2025050809301519.png" />
将发布生成的文件夹传到服务器上去，过程略。
IIS添加网站：
<blockquote>应用程序池选择刚才创建的 物理路径选择刚才上传的文件夹 绑定的端口选择空端口（不用和项目中json配置的一样）</blockquote>
<img alt="添加网站" src="https://img.jbzj.com/file_images/article/202505/2025050809301520.png" />
编辑权限中创建一个完全控制权限的账户
<img alt="创建用户权限" src="https://img.jbzj.com/file_images/article/202505/2025050809301521.png" />
点击”启动“运行，发现什么都没有。别忘记我们做的是API不是网站，地址换成接口URL就有了
<img alt="测试结果" src="https://img.jbzj.com/file_images/article/202505/2025050809301522.png" />
<img alt="测试结果" src="https://img.jbzj.com/file_images/article/202505/2025050809301523.png" />
Postman远程测试也没有问题：
<img alt="POSTMAN测试" src="https://img.jbzj.com/file_images/article/202505/2025050809301524.png" />
<a name="_label5"></a><h2>6、新增自定义接口</h2>
Controllers文件夹添加控制器
<img alt="新增控制器" src="https://img.jbzj.com/file_images/article/202505/2025050809301525.png" />
<img alt="新增控制器" src="https://img.jbzj.com/file_images/article/202505/2025050809301526.png" />
命名方式注意以Controller结尾
<img alt="新增控制器" src="https://img.jbzj.com/file_images/article/202505/2025050809301527.png" />
创建好后代码自动继承Controller。
<code>”)]</code>表示URL以类名MyAPI为路由地址，希望其他地址直接改字符串就行。
列举了4个请求的例子：
<div class="jb51code"><pre class="brush:csharp;">using Microsoft.AspNetCore.Mvc;

namespace WebAPI记录.Controllers
{

")]
public class MyAPIController : Controller
{
 // http://ip:port

 public string GetString()
 {
 return "Hello";
 }

 // http://ip:port/myapi/id

 public string GetStringByID(int id) // FromHeader属性表示从请求头获得参数
 {
 return "Hello " + id.ToString();
 }

 // http://ip:port/myapi/result

 public IActionResult GetStringResult()
 {
 var data = new { Message = "Hello" };
 return Ok(data); // Ok返回包含请求数据的HTTP 200
 }

 // http://ip:port/postdata

 public IActionResult PostData( DataModel data) // FromBody属性表示从请求的Body中读取并转为DataModel类
 {
 // 在这里处理接收到的数据
 return CreatedAtAction(nameof(PostData), null, new { Message = data }); // CreatedAtAction返回包含创建资源的 URL 的 HTTP 201 响应
 }
}
}
</pre></div>
DataModel类：
<div class="jb51code"><pre class="brush:csharp;">namespace WebAPI记录
{
public class DataModel
{
 public string Name { get; set; }
 public int Value { get; set; }
}
}
</pre></div>
运行后已经可以访问结果了
<img alt="运行结果" src="https://img.jbzj.com/file_images/article/202505/2025050809301628.png" />
测试结果：
<img alt="测试结果" src="https://img.jbzj.com/file_images/article/202505/2025050809301629.png" />
<img alt="测试结果" src="https://img.jbzj.com/file_images/article/202505/2025050809301630.png" />
<img alt="测试结果" src="https://img.jbzj.com/file_images/article/202505/2025050809301631.png" />

頁: [1]

琼殿技术论坛's Archiver

.Net8 WebAPI项目创建部署的实现