webapi 集成swagger

参考资料:Stack Overflow

我自己写的demo:SwaggerDemoApi

在已有的webapi项目或者创建webapi项目中,打开nuget管理器

搜索:swagger

安装截图中的插件到你的webapi项目中 ,安装完成后,项目根目录下也可能会出现SwaggerNet.cs文件,把这个文件删除掉即可。如果没有出现就不用删除。

 

 这个插件是自动安装的,依赖于Swagger.Net.UI

安装完成之后,发现项目根目录--App_Start目录下回产生两个文件

打开SwaggerNet.cs文件,把我截图中的代码注释掉,不然会报错,报错信息:程序集“Swagger.Net, Version=0.5.1.0, Culture=neutral, PublicKeyToken=null”中的类型“Swagger.Net.XmlCommentDocumentationProvider”的方法“GetDocumentation”没有实现。

 把图中代码注释掉,就没有报错了。

运行起来后,在地址栏后加上/swagger,就可以自动跳转到对应的页面了。

 

集成到项目中报错:Not supported by Swagger 2.0: Multiple operations with path 'api/Blob' and method 'POST'. See the config setting - \"ResolveConflictingActions\" for a potential workaround

参考资料:Not supported by Swagger 2.0: Multiple operations with path

                 webapi 配置swagger出现问题:not supported by swagger 2.0

在代码

GlobalConfiguration.Configuration 
                .EnableSwagger(c =>
                    { ...

里面加上一句:

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

或者

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

哪个不报错就用哪个,自己看情况。加上之后就不报这个错误了,就成功的运行出来了。

 

2019.05.24 补充:

如何生成注释文档?参考资料:代码注释生成

 

2020.03.23 补充:

如何添加header验证?

  GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        c.OperationFilter<HttpHeaderFilter>();
                     }
复制代码
    public class HttpHeaderFilter : IOperationFilter
    {
        public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
        {
            if (operation.parameters == null)
                operation.parameters = new List<Parameter>();
            var filterPipeline = apiDescription.ActionDescriptor.GetFilterPipeline(); //判断是否添加权限过滤器
            var isAuthorized = filterPipeline.Select(filterInfo => filterInfo.Instance).Any(filter => filter is IAuthorizationFilter); //判断是否允许匿名方法 
            var allowAnonymous = apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any();
            if (isAuthorized && !allowAnonymous)
            {
                operation.parameters.Add(new Parameter { name = "Authorization", @in = "header", description = "Token", required = true, type = "string" });
            }
        }
    }
复制代码

 

posted @   大稳·杨  阅读(3187)  评论(0编辑  收藏  举报
编辑推荐:
· 一个奇形怪状的面试题:Bean中的CHM要不要加volatile?
· [.NET]调用本地 Deepseek 模型
· 一个费力不讨好的项目,让我损失了近一半的绩效!
· .NET Core 托管堆内存泄露/CPU异常的常见思路
· PostgreSQL 和 SQL Server 在统计信息维护中的关键差异
阅读排行:
· DeepSeek “源神”启动!「GitHub 热点速览」
· 微软正式发布.NET 10 Preview 1:开启下一代开发框架新篇章
· C# 集成 DeepSeek 模型实现 AI 私有化(本地部署与 API 调用教程)
· DeepSeek R1 简明指南:架构、训练、本地部署及硬件要求
· 2 本地部署DeepSeek模型构建本地知识库+联网搜索详细步骤
点击右上角即可分享
微信分享提示