如何在线快速搭建swagger API文档？

本文共计3989个文字，预计阅读时间需要16分钟。

在上一篇文章中，我们解释了什么是API，什么是SDK：[链接](https://www.cnblogs.com/tanshaoshenghao/p/16217608.)。今天，我们将继续系列文章的第二篇：如何编写API文档？

在上一篇文章中，我们讲解了什么是 api，什么是 sdk：

www.cnblogs.com/tanshaoshenghao/p/16217608.html

今天将来到我们万丈高楼平地起系列文章的第二篇：如何编写 api 文档？

咳咳，其实写 api 文档这个事情也没有一个统一的标准，写这篇文章更多地是分享与记录自己的一些心得体会。

曾经有大佬和我说，通过一个人的 api 设计大概率能看出他的工程水平，并且推荐我去看一些优秀的 api 设计，比如 aws 的 api。

后来我感觉，学 api 有点像研习四书五经，入门后谁都能吟两句，至于能否真正消化理解及能发挥多大价值，不同人有不同的造化。

所以，或许写 api 就像比武功吧，一招一式耍出来后，花架子或许能唬住大众，高手之间的交流则只可意会不可言传......

呃不过阿菌可能连花架子也算不上，所以就不在大家面前卖弄如何设计 api 了。

但关于怎么写 api 文档这样的业务小常识，感觉还是可以分享一下的！

让人又爱又恨的 api 文档

首先我想说的是，脱离现实谈理想都是耍流氓，据我自己的切身体会，这世界上大概率是没有人喜欢写 api 文档的。

毕竟工作本来就累，这代码一写完，测试不找碴已经是万幸了，要顺便改上几个 bug，谁还记得维护 api 文档嘛。