WebApi结合Swagger ui 实现在线接口文档

发布时间:2020-10-10 13:58:41 作者:zdx墨涵
来源:网络 阅读:1466

Step1 添加NuGet包 Swashbuckle

  WebApi结合Swagger ui 实现在线接口文档

  step2 修改SwaggerConfig.cs

  Swasshbuckle 安装完成之后会在App_Start下创建一个名为SwaggerConfig.cs的类,把内容替换为:

  WebApi结合Swagger ui 实现在线接口文档

  Step3 创建生成XML

  右键你的项目→属性→生成→选中下方的 "XML文档文件" 然后保存

  WebApi结合Swagger ui 实现在线接口文档

  step4 启动你的项目

  访问地址为:http://localhost:58192/swagger/

  WebApi结合Swagger ui 实现在线接口文档

  扩展:在Swagger中 实现 自定义 HTTP Header

  在开发移动端 API时常常需要验证权限,验证参数放在Http请求头中是再好不过了。WebAPI配合过滤器验证权限即可

  首先我们需要创建一个 IOperationFilter 接口的类。IOperationFilter:

  WebApi结合Swagger ui 实现在线接口文档

  在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码

  c.OperationFilter<HttpHeaderFilter>();

  WebApi结合Swagger ui 实现在线接口文档

  添加权限过滤器

  WebApi结合Swagger ui 实现在线接口文档

  运行 swagger

WebApi结合Swagger ui 实现在线接口文档

推荐阅读:
  1. Spring集成Swagger,3步自动生成API文档
  2. 接口文档管理工具-Postman、Swagger、RAP、DOClever

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

webapi、swagger ui wa gg

上一篇:使用python库xlsxwriter库来输出各种xlsx文件的示例

下一篇:易语言仿按键精灵录制键盘鼠标操作的代码

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》