docs:项目说明文档更新

main
bicijinlian 9 months ago
parent 97170c9d3e
commit fb509619d1

@ -1,12 +1,13 @@
项目说明 项目说明
======= =======
项目主要学习WebAPI启动项设置特别是默认启始页设置。特别是在部署为子站点时的默认启动页。 项目主要学习WebAPI启动项设置特别是默认启始页设置。特别是在部署为子站点时的默认启动页。
常用方法: 常用方法:
+ 路由+重定向 + 路由+重定向
```charp ```csharp
//6.0及以上版本 //6.0及以上版本
app.Map("/", async context => app.Map("/", async context =>
{ {
@ -16,8 +17,6 @@
}); });
//或者MapGet方法 //或者MapGet方法
//老版本写法 //老版本写法
app.UseEndpoints(endpoints => app.UseEndpoints(endpoints =>
{ {
@ -28,9 +27,10 @@
}); });
}); });
``` ```
+ 路由+自定义内容 + 路由+自定义内容
```charp ```csharp
namespace LaunchUrlStudy.SubSite2 namespace LaunchUrlStudy.SubSite2
{ {
public class Program public class Program
@ -128,7 +128,8 @@
``` ```
+ 自定义中间件+重定向 + 自定义中间件+重定向
```charp
```csharp
namespace LaunchUrlStudy.SubSite4 namespace LaunchUrlStudy.SubSite4
{ {
public class Program public class Program
@ -163,12 +164,10 @@
} }
}); });
app.Run(); app.Run();
} }
} }
} }
``` ```
+ 第三方中间件:`Swagger中间件` 不支持子站点 + 第三方中间件:`Swagger中间件` 不支持子站点
@ -197,8 +196,6 @@
}); });
app.UseAuthorization(); app.UseAuthorization();
app.MapControllers(); app.MapControllers();
app.Run(); app.Run();
@ -210,7 +207,7 @@
+ 第三方中间件:`健康检查中间件` 即默认为健康检查地址 + 第三方中间件:`健康检查中间件` 即默认为健康检查地址
```charp ```csharp
namespace LaunchUrlStudy.SubSite6 namespace LaunchUrlStudy.SubSite6
{ {
public class Program public class Program
@ -241,7 +238,47 @@
+ 使用静态文件服务器UseDefaultFiles和UseStaticFiles + 使用静态文件服务器UseDefaultFiles和UseStaticFiles
```csharp ```csharp
namespace LaunchUrlStudy.SubSite7
{
public class Program
{
public static void Main(string[] args)
{
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
var app = builder.Build();
app.UseSwagger();
app.UseSwaggerUI();
app.UseAuthorization();
app.MapControllers();
// 配置启动地址(支持子站点):静态文件服务器默认页
// 只能是wwwroot里的静态真实文件不能是"swagger/index.html"(因为它是㠌入的资源文件不在wwwroot中)
app.UseDefaultFiles(new DefaultFilesOptions()
{
DefaultFileNames = new[]
{
//可以是静态文件
"index.html",
//不能是虚拟文件因为它是㠌入的资源文件不在wwwroot中
//"swagger/index.html"
}
});
app.UseStaticFiles();
app.Run();
}
}
}
``` ```
+ 环境变量与配置文件:不推荐 + 环境变量与配置文件:不推荐
@ -250,9 +287,9 @@
这需要事先知道子站点的值不灵活。环境变量可以在Docker中使用配置文件就太不灵活了。 这需要事先知道子站点的值不灵活。环境变量可以在Docker中使用配置文件就太不灵活了。
+ 部署配置 + 部署配置
在部署ASP.NET 6 Web API时配置服务器或反向代理服务器如Nginx或Apache来处理默认请求。例如在Nginx配置中设置默认页面 在部署 ASP.NET 6 Web API时配置服务器或反向代理服务器如Nginx或Apache来处理默认请求。例如在Nginx配置中设置默认页面
``` txt ```lua
server { server {
listen 80; listen 80;
server_name yourdomain.com; server_name yourdomain.com;
@ -265,13 +302,13 @@
proxy_cache_bypass $http_upgrade; proxy_cache_bypass $http_upgrade;
} }
} }
``` ```
+ 使用URL重写规则 不推荐 + 使用URL重写规则 不推荐
在使用IIS或Nginx等软件代理时可以设置URL重写规则。因为需要引入组件和配置规则相对来说太麻烦不推荐使用。 在使用IIS或Nginx等软件代理时可以设置URL重写规则。因为需要引入组件和配置规则相对来说太麻烦不推荐使用。
总结: 总结:
+ 优先使用: 自定义路由(重定向或自定义内容或文件) 和 自定义中间件,简单、灵活、支持站点也支持子站点; + 优先使用: 自定义路由(重定向或自定义内容或文件) 和 自定义中间件,简单、灵活、支持站点也支持子站点;
+ 如果启用了静态站点服务,可以配置 UseDefaultFiles 可以指定静态站点中的html文档 + 如果启用了静态站点服务,可以配置 UseDefaultFiles 可以指定静态站点中的html文档
+ 如果默认地址,用作 `健康检查路径`,也可以直接设置`健康检查路径`为站点首页; + 如果默认地址,用作 `健康检查路径`,也可以直接设置`健康检查路径`为站点首页;

Loading…
Cancel
Save