Skip to content

Latest commit

 

History

History
68 lines (57 loc) · 1.85 KB

README.md

File metadata and controls

68 lines (57 loc) · 1.85 KB

通过定义PHP Doc规则生成API文档

GitHub stars GitHub forks Packagist GitHub license

规则:

首行为空

第二行为描述

第三行以api开头,接上请求方式和URL

参数备注中不能出现空格,建议替换成标点符号

使用方法:

  1. 引入本库
composer require liluoao/api-doc

或直接下载源码

use your-namespace\ApiDoc;
//or
require 'src/ApiDoc.php';
  1. 实例化核心类

第一个参数是需要生成文档的文件夹路径

第二个参数可选,保存生成文档的路径,默认为当前目录

$apiDoc = new ApiDoc('test');
  1. 配置(可选

包括你的文档名,和 snake_case 转换 camelCase 的配置

$apiDoc->setName('example');
$apiDoc->setCamel2SnakeConfig(false, false, 0, 0);
  1. 执行
$apiDoc->init();

示例:

需要生成的文件:

示例代码 test/index.php

/**
 * 组合一句问候
 * api GET /index/hello
 * @param string $name 你想问候的人
 * @param string $say 问候语
 * @return string 组合后的话
 */
public function hello(string $name, string $say): string {
    return "Hello,{$name},{$say}";
}

结果:

example

注:生成后引入LayUI的路径需根据你生成路径修改