博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
C# 在webapi项目中配置Swagger
阅读量:6045 次
发布时间:2019-06-20

本文共 1518 字,大约阅读时间需要 5 分钟。

  这篇文章已经过时了,新的主要配置一个就行了,请参照:http://www.cnblogs.com/alunchen/p/7397396.html

Swagger是非常流行用于编辑api给前端同事用、或者测试api的工具。

 

1. 首先,创建webpapi类型的项目 TestSwagger

 

2. 安装swagger+swagger ui包

打开nuget界面,搜索swagger,并安装下面两个

安装完成之后,可以看到这些类与文件都是安装完成时swagger添加的

 

3. 打开xml文档文件

右键项目属性—>生成—>勾选XML文档文件

 

4. 运行

做好上述步骤后,运行,我发现我报错了

发生上述错误,请在,SwaggerNet类中,注释类上面的两行,就会运行成功

 

这时,运行成功

5. 添加注释

我们发现,安装完成后,写注释并没有在swagger页面上面增加,所以我们现在开开启注释

在SwaggerConfig类中,EnableSwagger的时候添加下面XML解析

c.IncludeXmlComments(GetXmlCommentsPath());

using System.Web.Http;using WebActivatorEx;using TestSwagger;using Swashbuckle.Application;[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]namespace TestSwagger{    public class SwaggerConfig    {        public static void Register()        {            var thisAssembly = typeof(SwaggerConfig).Assembly;            GlobalConfiguration.Configuration                 .EnableSwagger(c =>                    {                        c.SingleApiVersion("v1", "TestSwagger");                        //添加XML解析                        c.IncludeXmlComments(GetXmlCommentsPath());                    })                .EnableSwaggerUi(c =>                    {                                            });        }        //添加XML解析        private static string GetXmlCommentsPath()        {            return string.Format("{0}/bin/TestSwagger.XML", System.AppDomain.CurrentDomain.BaseDirectory);        }    }}

注意修改相应的XML名字。

 

posted on
2017-05-22 09:24 阅读(
...) 评论(
...)

转载于:https://www.cnblogs.com/alunchen/p/6888002.html

你可能感兴趣的文章
Unity3D研究院之获取摄像机的视口区域
查看>>
Ambari是啥?主要是干啥的?
查看>>
【知识必备】ezSQL,最好用的数据库操作类,让php操作sql更简单~
查看>>
快速排序
查看>>
安装完CentOS 7 后必做的七件事
查看>>
linux下svn服务器安装配置与启动
查看>>
连接Oracle错误:800a0e7a未找到提供程序的解决
查看>>
Webpack、Browserify和Gulp
查看>>
一次java Cpu占用过高的排查
查看>>
Zookeeper配置文件中的配置项解释和Zookeeper的安装
查看>>
MySQL索引原理及慢查询优化
查看>>
rsync 精确同步文件用法 (转载)
查看>>
使用Python实现一个简单的项目监控
查看>>
编译 boost
查看>>
Windows 10 IoT Serials 6 - 如何修改IoTStartupOnBoot.cmd文件
查看>>
只能在栈上或者堆上创建的对象
查看>>
Spring mvc 时间转换
查看>>
Spring第七弹—依赖注入之注解方式注入及编码解析@Resource原理
查看>>
ORA-00918:未明确定义列
查看>>
自适应滤波:矩阵求逆
查看>>