如何优雅的生成接口文档_PHP基础

当前位置：网站建设 > 技术支持

资料来源：网络整理时间：2023/3/5 15:07:01 共计：3609 浏览

如何优雅的生成接口文档？

说到优雅的接口文档，很多人不免都想到了Swagger，但是Swagger真的好吗？众所周知，这个框架对代码有很大的侵入性，况且需要程序员自行开发，甚至可能会出现30分钟开发完业务，1个小时写Swagger注解的情况。

所以，Swagger不能被称之为优雅。那么，就不得不说一下YApi了。

YAPI，专为接口管理而生，友好的接口文档，基于websocket的多人协作接口编辑功能和类postman测试工具，让多人协作成倍提升开发效率。支持MockServer，基于Mock.js，使用简单而功能强大。

项目管理

YAPI可以添加分组，可以为每个分组设置组长，组员，其他人无权限访问该分组。然后，分组内可创建项目，可定义基本路径，其实，可以简单理解为api接口的固定前缀，不单单指上下文根。例如，可以为 /shop/api 等。

创建接口

项目创建完成后，即可进入详情页进行后续操作。

创建接口也比较简单，其内容通俗易懂，直接填写即可。

在设置界面，可对项目及接口进行相关设置，如域名等，也可以设置域名为本地。

还可以查看项目的动态，也就是变动日志。

如果你之前做过Swagger的集成，那么，在这里可以直接导入，不必一一创建，既贴心又方便。

还可以开发一个wiki，方便接口使用者及开发者了解项目详情，接口逻辑。

当然了，如果团队成员发生变动，如新进人员、离职人员等，可以再次对项目成员进行管理。

另外，还支持MOCK配置、环境配置、全局MOCK脚本、Swagger自动同步等。

介绍至此，大家已然明白，相较于Swagger，YAPI对系统的侵入，可以说是零。也很符合其优雅的接口管理系统美名。

关于其他更详细的使用方面的问题，大家可下载部署安装之后，亲自尝试尝试，即可领略其魅力。

关注@银河架构师，发现更多精彩内容。

版权说明：
本网站凡注明“广州京杭原创”的皆为本站原创文章，如需转载请注明出处！
本网转载皆注明出处，遵循行业规范，如发现作品内容版权或其它问题的，请与我们联系处理！
欢迎扫描右侧微信二维码与我们联系。