sunkangchina/apidoc-php

根据注解生成API文档,兼容Laravel、ThinkPHP、Hyperf、Webman等框架;在线调试、Markdown文档、多应用/多版本、Mock数据、授权访问、接口生成器、代码生成器等众多实用功能

v10.0.0 2024-06-08 01:32 UTC

README

此包为修改后的包,以适应特定的项目使用。且不会同步来源包代码。 在config中原传path实为namespace,保留原path配置,但需传dir真实物理路径。

Apidoc

基于PHP的注解生成API文档及Api接口开发工具

🤷‍♀️ Apidoc是什么?

Apidoc是一个通过解析注解生成Api接口文档的PHP composer扩展,兼容Laravel、ThinkPHP、Hyperf、Webman等框架; 全面的注解引用、数据表字段引用,简单的注解即可生成Api文档,而Apidoc不仅于接口文档,在线接口调试、Mock调试数据、调试事件处理、Json/TypeScript生成、接口生成器、代码生成器等诸多实用功能,致力于提高Api接口开发效率。

✨特性

  • 开箱即用:无繁杂的配置、安装后按文档编写注释即可自动生成API文档。
  • 轻松编写:支持通用注释引用、业务逻辑层、数据表字段的引用,几句注释即可完成。
  • 在线调试:在线文档可直接调试,并支持全局请求/Mock参数/事件处理,接口调试省时省力。
  • 安全高效:支持访问密码验证、应用/版本独立密码;支持文档缓存。
  • 多应用/多版本:可适应各种单应用、多应用、多版本的项目的Api管理。
  • 分组/Tag:可对控制器/接口进行多级分组或定义Tag。
  • Markdown文档:支持.md文件的文档展示。
  • Json/TypeScript生成:文档自动生成接口的Json及TypeScript。
  • 代码生成器:配置+模板即可快速生成代码及数据表的创建,大大提高工作效率。

📌兼容

以下框架已内置兼容,可开箱即用

|框架|版本| |-|-|-| |ThinkPHP|5.1、6.x、8.x| |Laravel|8.x、9.x、10.x| |Webman|1.x| |Hyperf|2.x、3.x|

📖使用文档

https://docs.apidoc.icu

https://hg-code.gitee.io/apidoc-php/

🏆支持我们

如果本项目对您有所帮助,请点个Star支持我们

🌐交流群

QQ群

💡鸣谢

doctrine/annotations

🔗链接

ApiDoc UI

ApiDoc Demo