PHPackages                             itititi/tplapidoc - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. itititi/tplapidoc

ActiveLibrary[API Development](/categories/api)

itititi/tplapidoc
=================

基于自定义模板，生成你想要的api文档。简单易用且具备可拓展性。

1.1.4(7y ago)0251MITPHP

Since Jun 3Pushed 7y agoCompare

[ Source](https://github.com/iTiTiTi/tplapidoc)[ Packagist](https://packagist.org/packages/itititi/tplapidoc)[ RSS](/packages/itititi-tplapidoc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (1)Versions (7)Used By (0)

### 概述

[](#概述)

适用于php项目的 tplapidoc 是自动化文档接口生成工具。基于自定义模板生产api接口文档。

### 安装

[](#安装)

```
$ mkdir /data1
$ cd /data1
$ composer require itititi/tplapidoc
```

### 使用

[](#使用)

#### 普通方式

[](#普通方式)

\[usage\] cmd src dst

示例：/data1/vendor/bin/tplapidoc /data1/src/Demo.php /data1/dst

#### 建议写成shell脚本方便使用，如下：

[](#建议写成shell脚本方便使用如下)

```
$ vim apidoc.sh

#!/bin/bash

msg='更新接口'
if test ! -z $1 ;then
    msg=$1
fi

src=/data1/src/Demo.php
dst=/data1/dst/
cmd=/data1/vendor/bin/tplapidoc

cd $dst; find $dst ! -name '公共信息.md' -type f -exec rm -f {} \;
$cmd $src $dst

git add -A .
git commit -m "$msg"; git push
```

### 开发说明

[](#开发说明)

#### 解析接口来源文件

[](#解析接口来源文件)

/data1/src/Demo.php

```