ABP框架使用Swagger

最新推荐文章于 2024-04-30 11:08:07 发布

转载最新推荐文章于 2024-04-30 11:08:07 发布 · 257 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/xsj1989/p/9870738.html

本文详细介绍了如何在WebAPI项目中集成Swashbuckle，包括Nuget安装、SwaggerConfig配置、XML文档生成及查看API文档的具体步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

参考文档：https://www.cnblogs.com/xcsn/p/7910890.html

步骤1：Nuget安装Swashbuckle到*.WebApi项目

步骤2：在*.WebApi》App_Start》SwaggerConfig.cs中，把多余的注释删掉，只保留用到的。

using System.Web.Http;
using WebActivatorEx;
using Framework;
using Swashbuckle.Application;
using System.IO;
using System.Linq;

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

namespace Framework
{
    public class SwaggerConfig
    {
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        c.SingleApiVersion("v1", "Framework");//这个Framework是根据项目的前缀自动生成的，改成你自己的就好了

                        c.IncludeXmlComments(GetXmlCommentsPath("Application"));

                        c.UseFullTypeNameInSchemaIds();

                        c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());

                    }).EnableSwaggerUi("apis/{*assetPath}");
        }

        private static string GetXmlCommentsPath(string subName)
        {
            return Directory.GetFiles(System.AppDomain.CurrentDomain.BaseDirectory + "bin\\").FirstOrDefault(n => n.ToLower().EndsWith(subName.ToLower() + ".xml"));
        }
    }
}