https://github.com/lovemo/build_api
根据php文件相关代码注释,自动生成对应的接口文档和eolinker支持的格式文档,可导入到eolinker网站中
https://github.com/lovemo/build_api
api automatic documentation eolinker markdown php restful-api thinkphp5
Last synced: 3 months ago
JSON representation
根据php文件相关代码注释,自动生成对应的接口文档和eolinker支持的格式文档,可导入到eolinker网站中
- Host: GitHub
- URL: https://github.com/lovemo/build_api
- Owner: lovemo
- License: mit
- Created: 2018-12-19T03:20:11.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-19T03:27:14.000Z (about 7 years ago)
- Last Synced: 2024-12-27T21:14:29.093Z (about 1 year ago)
- Topics: api, automatic, documentation, eolinker, markdown, php, restful-api, thinkphp5
- Language: PHP
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# build_api
根据php文件相关代码注释,自动生成对应的接口文档和eolinker支持的格式文档,可导入到eolinker网站中
# core code
```php
#!/usr/bin/env php
[
// 生成目录
'build' => __DIR__ . '/demo.md',
'style' => [
'func' => [
'name' => '##',
'mark' => '####',
]
],
],
// eolinker样式
'eolinker' => [
// 生成目录
'build' => __DIR__ . '/demo.export',
],
// 模块所在路径
'path' => __DIR__ . '/../../../',
// 定义模块的自动生成
'module' => [
'api' => [
// 定义控制器的自动生成
[
'controller' => 'Test.php',
// [] 为所有
'action' => ['q', 'ww'],
]
],
],
];
```