温馨提示×

如何在C# WebAPI中使用Swagger

c#
小樊
152
2024-08-05 12:54:10
栏目: 编程语言

要在C# WebAPI中使用Swagger,您可以按照以下步骤操作:

  1. 安装Swashbuckle NuGet包:在Visual Studio中打开您的C# WebAPI项目,右键单击项目名称,选择“管理NuGet包”。在NuGet包管理器中搜索Swashbuckle,然后点击安装。

  2. 配置Swagger:在Global.asax.cs文件中,添加以下代码到Application_Start方法中:

GlobalConfiguration.Configure(WebApiConfig.Register);
SwaggerConfig.Register();
  1. 创建SwaggerConfig.cs文件并添加以下代码:
using Swashbuckle.Application;
using System.Web.Http;

public class SwaggerConfig
{
    public static void Register()
    {
        GlobalConfiguration.Configuration
            .EnableSwagger(c =>
                {
                    c.SingleApiVersion("v1", "Your API Name");
                })
            .EnableSwaggerUi();
    }
}
  1. 启动应用程序并访问Swagger UI:启动您的WebAPI应用程序,然后在浏览器中输入以下URL以访问Swagger UI:http://localhost:{your port}/swagger.

现在您已经成功在C# WebAPI中集成了Swagger,并可以使用Swagger UI来查看和测试API端点。

0