.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接口文档,为开发者提供清晰的接口定义和测试环境。请注意,以上步骤可能因项目配置和具体需求而有所不同,建议根据实际情况进行调整。

相关推荐
专注VB编程开发20年6 小时前
C#,VB.NET数组去重复,提取键名和重复键和非重复键
c#·.net·linq·取唯一键·去重复·重复数量
Full Stack Developme6 小时前
java.net 包详解
java·python·.net
假装我不帅18 小时前
wsl+vscode开发.net项目
ide·vscode·.net
CodeCraft Studio1 天前
国产化PDF处理控件Spire.PDF教程:如何在 C# 中从 HTML 和 PDF 模板生成 PDF
pdf·c#·html·.net·spire.pdf·pdf文档开发·html创建模板pdf
ysdysyn1 天前
.NET 10深度解析:性能革新与开发生态的全新篇章
c#·.net
fs哆哆2 天前
在VB.NET中,有没有 ?.这个运算符
java·开发语言·.net
荔园微风2 天前
微软ML.NET技术详解:从数据科学到生产部署的全栈解决方案
microsoft·.net
荔园微风2 天前
ML.NET机器学习框架基本流程介绍
人工智能·机器学习·.net
InCerry3 天前
为 .NET 10 GC(DATAS)做准备
性能优化·c#·.net·gc