菜单

什么样行使webapi集成swagger

2019年4月22日 - 葡京娱乐棋牌官网

  现在B/S开采中,前后端分离无疑已经化为①种新的前卫,可是怎么着把后端开采的接口更加好的提须要前段开拓呢?还用接口文档?low了吗。不仅要花时间支出接口,还得花时间写文书档案,白花花的年月不久荒废了啊。若是接口须求调动,还得改文书档案,那功能不用说了,显明够呛。今儿思明和豪门享受1篇可视化webapi接口开采,正是去集成swagger。

  先来差不离介绍一下:Swagger
是三个正经和完全的框架,用于转移、描述、调用和可视化 RESTful 风格的 Web
服务。总体目的是使客户端和文件系统作为服务器以同等的进程来更新。文件的艺术,参数和模型紧集中成到服务器端的代码,允许API来始终维持同步。Swagger
让安排管理和应用功效强大的API从未如此总结。

     上边介绍一下切实得以达成进度:

1、新建一个项目aps.net web 应用程序

图片 1

二、选拔 empty–>焦点引用选用 MVC和web api

图片 2

3、采用新建的花色右击,在菜单中选拔NuGet程序包
左边接纳联机,左侧输入框输入swagger

图片 3

挑选中间的 Swashbuckle 和Swagger UI for .NET四个安装

图片 4

四、右击项目采取菜单属性 –> 选取生成 –>
选拔输出xml文书档案文件,并输入不带多余.的公文名

图片 5

 

伍、把刚刚的文件名配置到 文件夹app_start中的 SwaggerConfig.cs 如下:

图片 6

c.IncludeXmlComments(string.Format("{0}/bin/SelfSwaggerApi.XML", System.AppDomain.CurrentDomain.BaseDirectory));

 6、删除多余无用的项

图片 7

七、在文书夹Controllers中新建三个 Web API 调节器类

图片 8

八、间接运行。http://localhost:16650/swagger/ui/index 结果如下:

图片 9

 

玖、有些人不想间接运维vs就足以自动跳转到 http://localhost:16650/swagger/ui/index
。也是能够的;如下:

在调控器中新扩展1个调控器 HomeController

using System.Web.Mvc;

namespace SelfSwaggerApi.Controllers
{
    public class HomeController : Controller
    {
        /// <summary>
        /// swagger 首页
        /// </summary>
        /// <returns></returns>
        public ActionResult Index()
        {
            return Redirect("/Swagger/ui/index");
        }
    }
}

  然后直接运营。。正是见证奇迹的时刻。

 

备注:常见难题

决不可能加载文件或程序集“System.Web.Http, Version=肆.0.0.0, Culture=neutral,
PublicKeyToken=3一bf3856ad36四e3伍”或它的某三个

案由剖析:程序所依附的dll
和实际引用的dll不适合,可以用修改配置文件web.config的办法实现包容

<runtime>
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="System.Web.Http.WebHost" publicKeyToken="31BF3856AD364E35" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.2.2.0" newVersion="5.2.2.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-7.0.0.0" newVersion="7.0.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="System.Net.Http.Formatting" publicKeyToken="31bf3856ad364e35" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.2.3.0" newVersion="5.2.3.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="System.Web.Http" publicKeyToken="31bf3856ad364e35" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.2.3.0" newVersion="5.2.3.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="System.Data" publicKeyToken="b77a5c561934e089" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.0.0" newVersion="4.0.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="System.Net.Http" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.0.0" newVersion="4.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>

  齐活。码字不易于,转发请备注出处,天涯论坛思明奉上

 

相关文章

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图