如何自动生成API文档?
如何自动生成API文档?

如何自动生成API文档?

相信各位开发者开发接口的时候 一定会用到postman来进行调试对吧 调试完最让人头疼的就是编写API文档 写的太简单了吧 人家技术不咋滴的看不懂 尝试以新手观看的角度来写 写的就有些复杂了 最终就会起到误导作用 把很多人绕进去了 写API文档也是技术活 一不小心被一堆技术围着骂 那我们如何避免这种情况呢?其实有很多工具 比如thinkPHP就有一种扩展库 可以实现自动编写文档 不过对于我们这种懒人来说 就有些麻烦了 😂 还想要更简单一些 可不可以在调试接口的时候 就能自动完成这个接口的文档的编写呢 答案是可以的 有一款工具就做到了这一点 他集成了postman功能 并且可以在你调试的时候就能自动生成文档 生成的文档相当清晰明了 并且文档你可以单独设置查看密码 以及文档链接过期时间 相当强大 而这一切只需要你点击一个保存接口的按钮即可 除了这些 它还支持API 可以将它集成到你们自己的系统或者erp中 可以很方便看到API接口实时开发到哪一步了 因为你接口调试的时候 点保存文档就出来了 可以显示状态是开发中还是完成还是修改中 并且你也可以自定义状态 然后像接口中的rsa签名啥的 它也可以完成 内置了这些插件只需配置一下即可 这些其实都不是最主要 最主要的就是你调试接口的时候 顺便就自动把文档生成了 个人感觉比那些扩展库使用方便多了 开发程序 你每个接口都反反复复测 必不可少的步骤 无非就是换个工具测 跟以前的工作流程相比完全没啥变化 但是文档它给你生成 这就很香了 当然最香的是 这个软件现在是永久免费使用 软件叫 APIpost 不仅仅是这些 还可以多人实时协作 它提供了软件版和web版 我个人强烈推荐下载软件 太方便了 有没有 软件支持Mac windows等等全平台的 这还不止 接口前后端的代码都可以自动生成 还有自动测试 太强了 强烈推荐

https://blog.csdn.net/BenChiZhuBaDaoWang/article/details/124542036

发表回复

您的电子邮箱地址不会被公开。