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

在.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文档的显示信息，例如设置文档的标题和描述。
    
  • 示例代码：
    
  
  

1. using System.Web.Http;
2. using WebActivatorEx;
3. using HRflag.WebAPI;
4. using Swashbuckle.Application;
6. [assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]
8. namespace HRflag.WebAPI
9. {
10.     public class SwaggerConfig
11.     {
12.         public static void Register()
13.         {
14.             var thisAssembly = typeof(SwaggerConfig).Assembly;
15.             GlobalConfiguration.Configuration
16.                 .EnableSwagger(c =>
17.                 {
18.                     c.SingleApiVersion("v1", "在线API文档");
19.                 })
20.                 .EnableSwaggerUi();
21.         }
22.     }
23. }

复制代码

 

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

 

1. using System;
2. using System.IO;
3. using System.Web.Http;
4. using WebActivatorEx;
5. using HRflag.WebAPI;
6. using Swashbuckle.Application;
8. [assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]
10. namespace HRflag.WebAPI
11. {
12.     public class SwaggerConfig
13.     {
14.         public static void Register()
15.         {
16.             var thisAssembly = typeof(SwaggerConfig).Assembly;
17.             GlobalConfiguration.Configuration
18.                 .EnableSwagger(c =>
19.                 {
20.                     c.SingleApiVersion("v1", "API文档");
21.                     var apiXml = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "bin\\HRflag.WebAPI.xml");
22.                     c.IncludeXmlComments(apiXml);
23.                 })
24.                 .EnableSwaggerUi();
25.         }
26.     }
27. }

复制代码

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

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

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。