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

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

  1. 安装Swashbuckle‌:

    • 在NuGet包管理器中搜索并安装"Swashbuckle"。请确保选择适合您项目的包版本。对于.NET Core API项目,请安装"Swashbuckle.AspNetCore"。
  2. 配置Swagger接口文档‌:

    • 在NuGet包管理器中搜索"Swashbuckle"。
    • 在项目中打开App_Start文件夹,定位到SwaggerConfig.cs配置文件。
    • 修改配置以自定义Swagger文档的显示信息,例如设置文档的标题和描述。
    • 示例代码:
cs 复制代码
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文档。
  1. 启用XML注释文件‌:

    • 在Visual Studio中,右键点击您的主项目,选择"属性"。
    • 在打开的项目属性窗口中找到"生成"选项卡。
    • 勾选"XML文档文件"复选框以启用XML注释文件的生成,并指定或确认文件的输出路径。
    • 修改SwaggerConfig.cs文件以启用XML注释文件的使用:
cs 复制代码
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注释文件。
  1. 运行项目并访问Swagger UI‌:

    • 启动Web API项目后,通过在服务地址后添加/swagger访问Swagger UI,即可查看API文档。
  2. Swagger文档的汉化‌:

    • 如果默认界面为英文,需要进行相应的汉化配置。这通常涉及到下载并安装支持中文的Swagger UI包,并修改配置以使用中文界面。
  3. 添加登录验证‌:

    • 对于需要添加登录验证的Swagger配置,可以在SwaggerConfig.cs中进行相应的配置,如使用JWT Token验证等。

通过以上步骤,您可以在.NET Framework 4.7.2中成功配置Swagger接口文档,为开发者提供清晰的接口定义和测试环境。请注意,以上步骤可能因项目配置和具体需求而有所不同,建议根据实际情况进行调整。

相关推荐
唐青枫13 小时前
从入门到进阶:C#.NET Stopwatch 计时与性能测量全攻略
c#·.net
私人珍藏库14 小时前
[Windows] 微软 .Net 运行库离线安装包 | Microsoft .Net Packages AIO_v09.09.25
microsoft·.net·运行库
追逐时光者1 天前
C#/.NET/.NET Core技术前沿周刊 | 第 54 期(2025年9.8-9.14)
后端·.net
追逐时光者1 天前
C#/.NET/.NET Core编程技巧练习集,配套详细的文章教程讲解!
后端·.net
咕白m6251 天前
C# Excel 读取入门教程:免费实现方法
c#·.net
唐青枫2 天前
FluentData 从入门到精通:C#.NET 数据访问最佳实践
c#·.net
余衫马2 天前
开发指南:使用 MQTTNet 库构建 .Net 物联网 MQTT 应用程序
物联网·mqtt·.net
William Wang~3 天前
.net 类库生成的DLL源码混淆加密
.net
一个帅气昵称啊3 天前
Docker命令大全:从基础到高级实战指南
docker·容器·eureka·架构·.net
Eiceblue3 天前
使用 C# 设置 Excel 单元格格式
开发语言·后端·c#·.net·excel