如何通过实战优化Swagger,提升API文档的易用性和准确性?
- 内容介绍
- 文章标签
- 相关推荐
本文共计1865个文字,预计阅读时间需要8分钟。
目录+背景+探索解决+一、先看看v1加载慢,但需要加载两次。
二、接下来处理v1加载慢的问题。
三、将需要返回的json数据。
四、修改Swagger页面。
五、总结+背景+探索解决+一、先看看v1加载慢,需要加载两次。
二、处理v1加载慢问题。
三、返回json数据。
四、调整Swagger界面。
五、总结
目录
- 背景
- 探察&解决
- 一、先看看v1加载慢,却要加载两次。
- 二、接下来处理v1加载慢
- 三、将需返回json数据
- 四、修改Swagger页面
- 结语
背景
尽管.net6已经发布很久了,但是公司的项目由于种种原因依旧基于.net Framework。伴随着版本迭代,后端的api接口不断增多,每次在联调的时候,前端开发叫苦不迭:“小胖,你们的swagger页面越来越卡了,快优化优化!”。
先查看swagger页面加载耗时:
以上分别是:
- v1加载了两次
- 重新编译程序后打开swagger页面,加载v1(api json)竟然耗时两分多钟。
本文共计1865个文字,预计阅读时间需要8分钟。
目录+背景+探索解决+一、先看看v1加载慢,但需要加载两次。
二、接下来处理v1加载慢的问题。
三、将需要返回的json数据。
四、修改Swagger页面。
五、总结+背景+探索解决+一、先看看v1加载慢,需要加载两次。
二、处理v1加载慢问题。
三、返回json数据。
四、调整Swagger界面。
五、总结
目录
- 背景
- 探察&解决
- 一、先看看v1加载慢,却要加载两次。
- 二、接下来处理v1加载慢
- 三、将需返回json数据
- 四、修改Swagger页面
- 结语
背景
尽管.net6已经发布很久了,但是公司的项目由于种种原因依旧基于.net Framework。伴随着版本迭代,后端的api接口不断增多,每次在联调的时候,前端开发叫苦不迭:“小胖,你们的swagger页面越来越卡了,快优化优化!”。
先查看swagger页面加载耗时:
以上分别是:
- v1加载了两次
- 重新编译程序后打开swagger页面,加载v1(api json)竟然耗时两分多钟。

