美文网首页
C# webapi 配置 swagger

C# webapi 配置 swagger

作者: __小白___ | 来源:发表于2019-02-27 11:56 被阅读0次

    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是不会显示在列表上的 。

    相关文章

      网友评论

          本文标题:C# webapi 配置 swagger

          本文链接:https://www.haomeiwen.com/subject/rbvxuqtx.html