PHP API 接口文档生成简单版本基于一位大哥的代码改的

最新推荐文章于 2024-11-15 10:50:34 发布

原创最新推荐文章于 2024-11-15 10:50:34 发布 · 3k 阅读

2 ·

CC 4.0 BY-SA版权

分享同时被 3 个专栏收录

13 篇文章

订阅专栏

原创

13 篇文章

订阅专栏

php代码段

10 篇文章

订阅专栏

本文介绍了一个用于自动生成API文档的工具apidoc的使用方法。包括如何通过URL获取所有列表及参数说明，同时提供了示例代码展示如何配置和生成文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

https://github.com/cnPauLi/apidoc.git

使用方法如下

/**
 * 获取所有列表
 * api GET api.php/index/index/all
 * @param integer $page 页数
 * @param integer $limit 每页个数
 * @return integer $code 状态码
 * @return string $msg 返回消息
 * @return array $void 结果!!!
 *
 * // 地址中新增两个占位符写法
 * // api.php/index/{controller}/{method}
 * // {method} 会自动换成对应的方法名
 * // {controller} 会自动换成文件名(大驼峰会转成匈牙利)。
 * //--------------------------------
 * // 默认是文件名和方法名都开启大驼峰转换
 * // 文件名是大写字母出现1次以及以上就转换
 * // 方法名是大写字母出现2次以及以上就转换
 * // 可以通过下面方法去改变,参数1是文件名,参数2是方法名
 * // $doc->setChange(true,true);
 * // $doc->setTime(1,2);
 */
public function index()
{
   $API_FILES_PATH_ARRAY = [
      'app\\flea\\api\\Flea',
      'app\\flea\\api\\Fleacart',
      'app\\flea\\api\\Fleacategory',
      'app\\flea\\api\\Fleagoods',
      'app\\flea\\api\\Fleapay',
      'app\\flea\\api\\Shareimg',
      'app\\flea\\api\\Fleaaddress',
      'app\\flea\\api\\Fleasharechain',
      'app\\flea\\api\\Fleabindingshops',
      'app\\flea\\api\\Fleaslide',
      'app\\flea\\api\\Fleareport',
      'app\\flea\\api\\Felawallet',
      'app\\flea\\api\\Flearichtext',
      'app\\paygateway\\api\\Wallet',
   ];
   $doc = new ApiDoc($API_FILES_PATH_ARRAY);
   $doc->setName(RUNTIME_PATH . 'api');
   echo $doc->make(true);
}