.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年1 小时前
vb.net oledb-Access 数据库本身不支持命名参数,赋值必须和参数顺序一致才行
数据库·c#·.net·vb.net·oledb
界面开发小八哥2 小时前
界面开发框架DevExpress XAF实践:集成.NET Aspire后如何实现自定义遥测?
.net·界面控件·devexpress·ui开发·xaf
o0向阳而生0o11 小时前
56、Ocelot 概述
微服务·.net
xdpcxq102916 小时前
.NET 开源工业视觉系统 OpenIVS 快速搭建自动化检测平台
开源·自动化·.net
yuanpan17 小时前
同为.net/C#的跨平台运行时的mono和.net Core有什么区别?
c#·.net·.netcore
coredx2 天前
如何在 .NET 中构建一个好用的动态查询生成器
c#·.net·linq·ef core·表达式树
晴天_QingTian2 天前
.NET8入门:14.ASP.NET Core MVC进阶——Model
asp.net·mvc·.net
码小跳2 天前
如何使用.Net Reactor 批量加密 DLL
c#·.net
Kookoos3 天前
ABP VNext + CRDT 打造实时协同编辑
c#·.net·yjs·crdt·abp vnext
o0向阳而生0o3 天前
54、C# 委托 (Delegate)
开发语言·c#·.net