首页 / ASP.NET / 使用Swagger 搭建高可读性ASP.Net WebApi文档

使用Swagger 搭建高可读性ASP.Net WebApi文档

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了使用Swagger 搭建高可读性ASP.Net WebApi文档，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含939字，纯文字阅读大概需要2分钟。

内容图文

一、前言

在最近一个商城项目中，使用WebApi搭建API项目。但开发过程中，前后端工程师对于沟通接口的使用，是非常耗时的。之前也有用过Swagger构建WebApi文档，但是API文档的可读性并不高。尤其是没有传入参数和传出结果的说明，导致开发人员沟通困难。在园子里看到一篇关于对Swagger优化的文章，有很大的改进。解决了传入参数，API分区域筛选等问题， 非常感谢博主简玄冰。

不过实践之后，发现还有些问题未解决:

  1. 接口返回的对象，没有汉化说明
  2. 接口授权参数(token)未统一传入

所以，决定在此基础上，再进行一些优化

二、效果图

1. 分区域展示

技术分享图片

2.接口参数说明

技术分享图片

   

技术分享图片

3.授权参数统一传入 token

技术分享图片

   

4.接口查询

技术分享图片

5.接口开发状态

   

技术分享图片

三、关键实现

1.项目属性设置生成xml文档文件

技术分享图片

技术分享图片

   

2.修改SwaggerConfig.cs文件

   

技术分享图片

3. 修改WebApiConfig.cs文件，配置路由

技术分享图片

   

4.分区域筛选关键逻辑

 需要注意: 实现逻辑与命名空间的分割符. 有很大关系，具体请查看文件SwaggerAreasSupportDocumentFilter.cs

 技术分享图片

   

四、Demo源码地址

  Github: https://github.com/yinboxie/Swagger-Demo.git

  下载demo源码后，如果发现不能自动下载nuget依赖包，请执行命令 Update-Package -ProjectName ‘ swagger.demo.api ‘ -Reinstall

技术分享图片

 启动项目之后，访问地址http://localhost:11008/apis/index

五、总结

Swashbuckle 源码是没有注释说明，比较难以阅读。我也只是在大神 简玄冰 的基础上，修改了几处Swashbuckle 源码。

改动之后的Swashbuckle 源码 Github: https://github.com/yinboxie/SwashbuckleEx.git

六、参考

原文：https://www.cnblogs.com/xyb0226/p/9500633.html

内容总结

以上是互联网集市为您收集整理的使用Swagger 搭建高可读性ASP.Net WebApi文档全部内容，希望文章能够帮你解决使用Swagger 搭建高可读性ASP.Net WebApi文档所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/1092104.html

来源：【匿名】