Swagger——与WebAPI整合

1. Swagger（俗称：丝袜哥）是什么东西？

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

2.丝袜哥可以干什么？

a.接口，服务可视化，非常清晰，好用

b.做接口测试，方便测试人员使用

3.Swagger怎么和WebApi集成？

第一步：创建WebApi工程

第二步：引入swagger的包（Swashbuckle、swagger两个）

第三步：打开解决方案属性-->生成，勾选XML文档文件，保存

swagger在生成xml注释文档之后会保存到当前appdomaim下的bin目录，用于在UI上展示

第四步：找到swaggerconfig文件的注册方法，去掉下面注释的这一句代码，用于在UI上加载生成的xml文档

GetXmlCommentsPath方法的实现如下：读取注释文件的路径

private static string GetXmlCommentsPath()

{

return string.Format("{0}/bin/WebApiSwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory);

}

第五步：打开swggernet文件，注释掉下面的两行代码（估计是nuget包中的代码没有更新导致这个异常出现）

第六步：swagger已经集成成功了，在浏览器输入：http://localhost:37033/swagger/ui/index 就可以看到界面了

第七步：开发自己的API模块

/// <summary>

/// 更新订单信息

/// </summary>

/// <param name="input"></param>

/// <returns></returns>

[HttpPost, Route("order/UpdateOrder")]

public OutPutResult UpdateOrder(BusinessModel input)

{

return new OutPutResult() { Success = false, Message = "恭喜你更新订单成功！" };

}

　　指定路由地址 order/UpdateOrder 和访问方式 Post/Get/Put

第八步：测试调用

通过Swaggerui可以通过你的Comtroller来分模块浏览和测试接口列表

Swagger——与WebAPI整合相关推荐

SpringBoot一站式功能提供框架（一）整合MybatisPlus、整合Swagger Knif4j、整合Druid多数据源--柚子真好吃
SpringBoot一站式功能提供框架(一)整合MybatisPlus.整合Swagger Knif4j.整合Druid多数据源--柚子真好吃一.前言二.功能描述三.具体实现四.开源地址一. ...
NetCore 2.0 + Swagger 的WebAPI 模板例子
NetCore2.2.5 新瓶装旧酒.一个极简的WebAPI/MVC开发环境,封装一些常用的类包. 代码地址:https://github.com/linqingwudiv1/NetCoreWebAP ...
NetCore+Dapper WebApi架构搭建（五）：Swagger构建WebApi界面
上一节讲解了仓储的依赖注入,想必现在都可以通过构造函数依赖注入直接调用但是WebApi只是提供一个接口调用,为了方便我们的操作,我们得给他加上一个图形化界面工具,使用Swagger WebApi项目 ...
spring-boot+swagger实现WebApi文档
1.引用依赖包 <dependency><groupId>io.springfox</groupId><artifactId>springfox-swa ...
【Swagger】 SrpingBoot整合Swagger
配置一.添加依赖 <dependency><groupId>io.springfox</groupId><art ...
swagger和jwt整合问题笔记
1.引入 swagger开发包增加pom文件配置 <dependency> <groupId>io.springfox</groupId> ...
03、Swagger2和Springmvc整合详细记录（爬坑记录）
时间内容备注 2018年6月18日基本使用 spirngmvc整合swagger2 开始之前这个系列博文基本是,在项目的使用中一些模块的内容记录,但是后期逐渐优化,不单单是整合内容. swagg ...
swagger使用指南
前言:作为一个以前后端分离为模式开发小组,我们每隔一段时间都进行这样一个场景:前端人员和后端开发在一起热烈的讨论"哎,你这参数又变了啊","接口怎么又请求不通了啊&quo ...
swagger 使用指南
前言:作为一个以前后端分离为模式开发小组,我们每隔一段时间都进行这样一个场景:前端人员和后端开发在一起热烈的讨论"哎,你这参数又变了啊","接口怎么又请求不通了啊&quo ...

Swagger——与WebAPI整合

Swagger——与WebAPI整合相关推荐

最新文章

热门文章