今天给各位网友举荐一款基于PHP的注解生成API文档及Api接口研发工具。她便是【Apidoc】!~~~~
Apidoc是什么?
Apidoc是一个经过解析注解生成Api接口文档的PHP composer扩展; 全面的注解引用、数据表字段引用,简单的注解就可生成Api文档,而Apidoc不仅于接口文档,在线接口调试、Mock调试数据、调试事件处理、Json/TypeScript生成、批量测试、接口分享、代码生成器、Api市场等许多实用功能,致力于加强Api接口研发效率。
#✨特性开箱即用:无繁杂的配置、安装后按文档编写注释就可自动生成API文档。容易编写:支持通用注释引用、业务规律层、数据表字段的引用,几句注释就可完成。在线调试:在线文档可直接调试,并支持全局请求/Mock参数/事件处理,接口调试省时省力。安全有效:支持拜访秘码验证、应用/版本独立秘码;支持文档缓存。多应用/多版本:可适应各样单应用、多应用、多版本的项目的Api管理。分组/Tag:可对掌控器/接口进行多级分组或定义Tag。Markdown文档:支持.md文件的文档展示。Json/TypeScript生成:文档自动生成接口的Json及TypeScript。代码生成器:配置+模板就可快速生成代码及数据表的创建,大大加强工作效率。
#兼容
以下框架已内置兼容,可开箱即用。其它框架可参考其它框架安装说明进行手动兼容。
框架
版本
说明
ThinkPHP
5.1、6.x
Laravel
8.x、9.x
其它版本未测试
Hyperf
2.x
其它版本未测试
Webman
2.x
需手动配置兼容
运用文档
https://docs.apidoc.icu/
|