# fastadmin 插件文档生成

**Repository Path**: cikiche/fast_doc

## Basic Information

- **Project Name**: fastadmin 插件文档生成
- **Description**: 购买了fastadmin的插件，怎么能没有文档呢？

- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2020-11-28
- **Last Updated**: 2024-03-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### fastadmin 插件文档生成

### 更新
看到有用户 star 了本文，感谢 star，更新一下吧。
#### 更新了啥？
Q: 在 class 类里面增加了 ApiInternal 后，自动生成文档依旧会显示 ApiInternal 的标题？

A: 解决方案请看 [ignoreApiClass.md](ignoreApiClass.md)

Q: 目前，默认的生成 api 文档目录只能显示 api 目录，如何生成多目录？

A: 解决方案请看 [adddir.md](adddir.md)
 
### 说明
前两天看到 fastadmin 的作者已经增加了插件文档生成功能，预计应该会在下一个版本里面发出来，但是目前不清楚下一个版本放出来的时间，所以本文仅供有需要的参考。

#### 介绍
购买了fastadmin的插件，怎么能没有文档呢？


#### 软件架构
基于 fastadmin 对 api 生成工具进行 小修小改

适用版本:理论上适用 2020/11/28 号以前的所有版本。

#### 本文读者范围：

熟悉 PHP 语法，会使用 PHP 命令行
熟悉 thinkphp 和 fastadmin
能够对 fastadmin 进行二次开发

 
#### 修改方法

1. 打开你的项目根目录

2. 打开 \application\admin\command\Api.php

3. 找到第 66 行。 对应代码如下:

   ``` php 
   $moduleDir = APP_PATH . $module . DS;
   ```

   

4.  通过代码可以得知：APP_PATH 为 application 目录，而 addons 为平级目录。也就是说，这段代码是无法获取 addons 的目录下的东西的，想要获取 addons 的代码需要动下手术刀

5. 我的思路：

   直接判断用户输入的代码有没有 addons 目录

6. 直接上代码

	
```php
	   if(strpos($module, 'addons') !== false){
	       $moduleDir = ROOT_PATH . $module . DS;
	   }else{
	       $moduleDir = APP_PATH . $module . DS;
	   }
```

7. 保存文件

#### 使用说明


1. CMD 进入项目目录（当前目录下有一个 think 文件的目录）
2. 执行命令

 ```php
php think api -o api.html -m addons/recruit --force=true
 ```

即可看到效果

#### 关于命令的说明
和fastadmin 生成 api 命令一模一样，不一样的地方就是 生成插件文档的时候，需要指定插件。例如本文中的 -m addons/recruit .
这里的意思就是生成  recruit 插件的插件文档

#### 参与贡献

1.  Fork 本仓库
2.  修改
3.  提交代码
4.  新建 Pull Request