当前位置：首页 > article >正文

.NET Framework 4.7.2 创建 Swagger的API 的设置

article 2025/1/4 4:03:24

在.NET Framework 4.7.2中，Swagger是一个用于自动生成和维护API文档的工具，它允许开发者和用户在没有直接访问源代码的情况下了解REST API的功能。以下是配置.NET Framework 4.7.2 Web API中的Swagger的步骤：

‌安装Swashbuckle‌：
- 在NuGet包管理器中搜索并安装“Swashbuckle”。请确保选择适合您项目的包版本。对于.NET Core API项目，请安装“Swashbuckle.AspNetCore”。
‌配置Swagger接口文档‌：
- 在NuGet包管理器中搜索“Swashbuckle”。
- 在项目中打开App_Start文件夹，定位到SwaggerConfig.cs配置文件。
- 修改配置以自定义Swagger文档的显示信息，例如设置文档的标题和描述。
- 示例代码：

using System.Web.Http;
using WebActivatorEx;
using HRflag.WebAPI;
using Swashbuckle.Application;

[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]

namespace HRflag.WebAPI
{
    public class SwaggerConfig
    {
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;
            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                {
                    c.SingleApiVersion("v1", "在线API文档");
                })
                .EnableSwaggerUi();
        }
    }
}

- 这段代码配置了Swagger的单一版本API文档。
‌启用XML注释文件‌：
- 在Visual Studio中，右键点击您的主项目，选择“属性”。
- 在打开的项目属性窗口中找到“生成”选项卡。
- 勾选“XML文档文件”复选框以启用XML注释文件的生成，并指定或确认文件的输出路径。
- 修改SwaggerConfig.cs文件以启用XML注释文件的使用：

using System;
using System.IO;
using System.Web.Http;
using WebActivatorEx;
using HRflag.WebAPI;
using Swashbuckle.Application;

[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]

namespace HRflag.WebAPI
{
    public class SwaggerConfig
    {
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;
            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                {
                    c.SingleApiVersion("v1", "API文档");
                    var apiXml = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "bin\\HRflag.WebAPI.xml");
                    c.IncludeXmlComments(apiXml);
                })
                .EnableSwaggerUi();
        }
    }
}

- 这段代码配置了Swagger以使用生成的XML注释文件。
‌运行项目并访问Swagger UI‌：
- 启动Web API项目后，通过在服务地址后添加/swagger访问Swagger UI，即可查看API文档。
‌Swagger文档的汉化‌：
- 如果默认界面为英文，需要进行相应的汉化配置。这通常涉及到下载并安装支持中文的Swagger UI包，并修改配置以使用中文界面。
‌添加登录验证‌：
- 对于需要添加登录验证的Swagger配置，可以在SwaggerConfig.cs中进行相应的配置，如使用JWT Token验证等。