将ASP.NET 4.6帮助页迁移到.NET 6(.NET核心)



在.NET框架中,我们支持为Web API创建帮助页。

https://learn.microsoft.com/en-us/aspnet/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages

.NET 6是否支持此功能。我们正在将旧版ASP.NET框架应用程序迁移到.NET6。

如何将此功能迁移到.NET6?如果.net 6(.net core(不支持它,我们如何在.net core 中实现类似的功能

我正试图将此功能迁移到.net核心,但我面临着如何加载应用程序数据、在.net核心中注册HelpdataConfig的问题。

如您在ASP.NET Core Web API的ASP.NET帮助页中所见,Microsoft.AspNet.WebApi.HelpPage适用于ASP.NET,而不适用于ASP.NET Core或.NET 6,因此您必须将此库迁移到一些流行的Web API文档库,如Swagger

正如您在带有Swagger/OpenAPI的ASP.NET Core web API文档中看到的,您可以使用以下文档

Christoph Nienaber和Rico Suter

Swagger(OpenAPI(是一个与语言无关的规范,用于描述RESTAPI。它允许计算机和人类在不直接访问源代码的情况下理解REST API的功能。其主要目标是:

  • 最大限度地减少连接解耦服务所需的工作量
  • 减少准确记录服务所需的时间

.NET的两个主要OpenAPI实现是Swashbuckle和NSwag,请参阅:

  • Swashbuckle入门
  • NSwag入门

最新更新