webapi 配置swagger_webapi swagger - CSDN
精华内容
参与话题
  • 3、WebApi的Controller继承的是ApiController,而Mvc的Controller继承的是Controller 4、Nuget配置Swagger 5、保存xml生成的文档 6、将SwaggerNet类中的命名空间上的两行代码注释掉 7、在...

    1、创建项目

    2.WebApiConfig中配置的是路由信息

    3、WebApi的Controller继承的是ApiController,而Mvc的Controller继承的是Controller

    4、Nuget配置Swagger

    5、保存xml生成的文档

    6、将SwaggerNet类中的命名空间上的两行代码注释掉

    7、在SwaggerConfig中添加XML解析,AspNetWebApiDemo.xml换成自己的

    8、运行程序,输入http://localhost:24371/swagger/ui/index

    ValuesController下面的方法

    展开全文
  • C# 在webapi项目中配置Swagger  这篇文章已经过时了,新的主要配置一个就行了,请参照:http://www.cnblogs.com/alunchen/p/7397396.html Swagger是非常流行用于编辑api给前端同事用、或者测试api的...

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

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

     

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

    image

     

    2. 安装swagger+swagger ui包

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

    image

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

    image

     

    3. 打开xml文档文件

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

    image

     

    4. 运行

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

    image

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

    image

     

    这时,运行成功

    image

    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 alun-chen 阅读(...) 评论(...) 编辑 收藏

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

    展开全文
  • C# webapi 配置 swagger

    2019-07-11 14:20:33
    2.程序包源选择nuget.org,然后搜索 swagger (丝袜哥儿...)哈哈,我喜欢这样读。 3.选择你要安装的项目 4.安装好了之后,在App_start 文件夹下的SwaggerConfig.cs中写入方法,然后在Register()方法调用 ...

    1.vs->工具->NuGet包管理器->管理解决方案的NuGet程序包

    2.程序包源选择nuget.org,然后搜索 swagger (丝袜哥儿...)哈哈,我喜欢这样读。

    3.选择你要安装的项目

    4.安装好了之后,在App_start 文件夹下的SwaggerConfig.cs中写入方法,然后在Register()方法调用

     

    private static string GetXmlCommentsPath()

            {

                return System.String.Format(@"{0}\bin\\dataForPractice.xml 这个是第5部配置的xml文件名", System.AppDomain.CurrentDomain.BaseDirectory);

            }

     

    5. 配置项目属性 (生成->勾选xml文档文件  对应的文件名就是第四步中需要填写的xml文件名)

     

    6.需要在Views->shared 下的_Layout.cshtml中加入dom节点(链接到swagger显示的do文档)

    <li>@Html.ActionLink("Swagger Help", "", "Swagger", new { area = "" }, null)</li> 

     

    7.接下来就是ctrl+f5了兄弟们,点击

    Swagger Help就可以看到 有方法备注,有传入参数的备注 

     

     

    8.天老爷,有一个巨坑的地方,给各位提醒下:就是如果你添加的控制器不是继承的ApiController这个类的话,swagger是不会显示在列表上的 。

     



    作者:__小白___
    链接:https://www.jianshu.com/p/d44d20978122
    来源:简书
    简书著作权归作者所有,任何形式的转载都请联系作者获得授权并注明出处。

    展开全文
  • C#在WEBAPI配置Swagger

    千次阅读 2019-05-25 23:36:17
    在C#中,开发WEBAPI很多时候需要前后端联调,这其中就涉及到接口文档,而Swagger可以直接把接口文档在代码里生成出来,当然,你的代码的注释一定要写全。 首先创建一个WebAPi,此处就不多阐述了,基本操作: ...

            在C#中,开发WEBAPI很多时候需要前后端联调,这其中就涉及到接口文档,而Swagger可以直接把接口文档在代码里生成出来,当然,你的代码的注释一定要写全。

          首先创建一个WebAPi,此处就不多阐述了,基本操作:

    然后在添加Nugget包:

    在APP_START里找到SwaggerConfig,

    在SwaggerConfig里增加配置:大概在108行左右,

    c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));

    在SwaggerConfig里最后面增加方法GetXmlCommentsPath

    protected static string GetXmlCommentsPath(string name)
            {
                return System.String.Format(@"{0}\bin\{1}.xml", System.AppDomain.CurrentDomain.BaseDirectory, name);
            }

     

    然后APIConfig里的routeTemplate下增加 /{action}/:

    routeTemplate: "api/{controller}/{action}/{id}"

    至此,配置就完成了。在你的项目里,配置继承了Apicontroller下,维护好<summary>,即可。

    在API项目生成里,勾选生成XML文档文件,保存:

    查看效果为你的网址后面加上swagger:

    这里都可以看到写在<summary>的注释。

    最后,提醒一点:controller要继承Apicontroller,同一controller不可有两个同名的方法,比如Get(),Get(int id).会报错。可通过配置Route解决。这里我就不多阐述了。

    展开全文
  • WebApi配置Swagger

    2020-04-27 12:00:04
    WebApi配置Swagger流程 1.添加NuGet包 在项目的NuGet包管理器中搜索名为Swashbuckle的包,然后安装 2.配置项目属性 生成中勾选XML文档,填写文件名 3.设置swagger 在App_Start文件夹下创建名为SwaggerConfig的类,...
  • ASP.NET 使用Swagger开发Web API接口项目

    千次阅读 2018-05-15 15:12:47
    ASP.NET 使用Swagger开发WebApi接口项目:项目使用Web API创建自动提供了API文档,采用mvc方式创建项目稍麻烦点需要手动添加WebApiConfig配置,而采用Web API项目这些都已经生成好了。创建Web API项目添加Swagger...
  • .Net WebApi接口调试之Swagger集成详解

    万次阅读 2016-07-19 10:25:39
    引:以前没有写博的习惯,后来 在网上看到有些问题被一些刚入行的同学...本文详细的介绍了.net从一个新的项目中创建api后集成swagger调试接口的流程! 1、首先我们创建一个MVC项目(VS2012): 2、然后在项目中的
  • 在Vue项目中利用swagger配置自动生成访问后台WebApi代码的功能WebApi后台配置Vue前端配置 最近在做Vue的前端项目,需要配置自动生成访问WebApi的代码,网上并没有找到相关教程,把我最终找到的解决方案放在这里帮助...
  • ASP.NET WebAPI 使用Swagger在线接口文档

    千次阅读 2018-06-21 14:19:57
    关于 SwaggerSwagger能成为最受欢迎的REST APIs文档生成工具之一,有以下几个原因:Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试APISwagger 可以生成客户端SDK代码用于各种不同的...
  • .NET Web API 搭建Swagger

    千次阅读 2019-05-11 11:44:27
    2.选择空模板,并且勾选web api 3.生成web api项目后,添加controller文件 4.自动回生成content、views等文件夹及文件 5.可直接运行,程序异常 6.Global.asax添加配置 代码如下: protected ...
  • 不说废话直接上解决方案。 一般都是使用Model类库,因为传参的话都是Model里来的,当然如果有定义比如:出入参的类库,下面我就按Model类库来说,其它类库也按以下步骤来就行了。 第一步:选中Model类型右键——...
  • JavaWeb项目中集成Swagger API文档

    千次阅读 2019-03-19 20:14:04
    在基于Spring和SpringMVC的前后端分离的JavaWeb项目中生成Swagger API文档(使用SpringFox来实现)。 1 SpringFox和Swagger简介 结合SpringFox通过注解的形式自动生成Swagger API文档(HTML页面形式),该文档还...
  • Swagger如何访问需要权限验证的Web API

    万次阅读 2018-07-02 14:04:00
    Swagger如何访问需要权限验证的Web API这篇博文不是对asp.net core中使用Swagger作介绍,因为社区博客作了详细说明。今天主要说一下Swagger在Ocelot网关权限验证模式下的访问,以及Swagger请求应答的数据格式。首先...
  • springMVC整合swagger(亲自试验完全可用)

    万次阅读 热门讨论 2016-12-16 16:35:40
    swagger是什么: Swagger 是一款RESTFUL...Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数
  • spring-boot作为当前最为流行的Java web开发脚手架,相信越来越多的开发者会使用其来构建企业级的RESTFul API接口。这些接口不但会服务于传统的web端(b/s),也会服务于移动端。
  • Spring3 MVC中使用Swagger生成API文档

    万次阅读 热门讨论 2016-02-19 23:19:56
    swagger集成springMVC框架,自动生成接口文档与测试框架。
  • Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTFul 风格的 Web 服务。通过 Swagger,我们可以方便的、快速的实现 RESTFul API,同时它也提供UI...Docker镜像仓库Harbor之Swagger REST API整合配置
  • java swagger ui 添加header请求头参数

    万次阅读 2018-02-07 19:32:02
    我用到的swagger 主要有三款产品,swagger editor,swagger ui 和swagger codegen。  swagger editor:主要是一个本地客户端,用来自己添加api,自己来测试,相当于一个api的可视化测试工具和定义工具吧。  ...
  • C# ABP WebApiSwagger UI的集成

    千次阅读 2017-05-05 17:04:30
    首先,将Swagger安装到WebApi项目中。我们安装到WebApi类库中,包为 Install-Package Swashbuckle.Core,如下:   2. 配置 WebApiModule 我们打开WebApi类库下面的WebApiModule类,因为我们的项目叫MyThirdABP...
  • 使用第三方提供的swgger ui 可有效提高 web api 接口列表的阅读性,并且可以在页面中测试服务接口。 但本人在查阅大量资料并进行编码测试后,发现大部分的swagger实例并不能有效运行。原来是由版本的差异导致的...
1 2 3 4 5 ... 20
收藏数 13,021
精华内容 5,208
关键字:

webapi 配置swagger