PHPackages                             opqnext/reflection-api-doc - 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. opqnext/reflection-api-doc

ActiveLibrary

opqnext/reflection-api-doc
==========================

一个基于 Thinkphp5 的 api 文档自动生成工具

v1.0(8y ago)2665811[2 issues](https://github.com/opqnext/Reflection_Api_Doc/issues)[1 PRs](https://github.com/opqnext/Reflection_Api_Doc/pulls)MITHTMLPHP >=5.3.0

Since Aug 29Pushed 7y ago1 watchersCompare

[ Source](https://github.com/opqnext/Reflection_Api_Doc)[ Packagist](https://packagist.org/packages/opqnext/reflection-api-doc)[ RSS](/packages/opqnext-reflection-api-doc/feed)WikiDiscussions master Synced 5d ago

READMEChangelogDependenciesVersions (3)Used By (0)

reflection\_api\_doc
====================

[](#reflection_api_doc)

这是一个基于 thinkphp5.0 的PHP自动生成api文档的库

[![Latest Stable Version](https://camo.githubusercontent.com/83763a86ee2845299cb37ea6601f1544cf8494d0b2b6cf9a3c7f8d4a0a7da575/68747470733a2f2f706f7365722e707567782e6f72672f6f70716e6578742f7265666c656374696f6e2d6170692d646f632f762f737461626c652e737667)](https://packagist.org/packages/opqnext/reflection-api-doc)[![Total Downloads](https://camo.githubusercontent.com/e0298a1012fe938a925df8906f2b63b0a0c5654ab1cbfb68b606c19a794321ae/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6f70716e6578742f7265666c656374696f6e2d6170692d646f632e737667)](https://packagist.org/packages/opqnext/reflection-api-doc)[![Latest Unstable Version](https://camo.githubusercontent.com/8b33d07fbb228ce88b70cd8731a1ce3dbd1151f8aadf9d0e0be10c59d74e2b14/68747470733a2f2f706f7365722e707567782e6f72672f6f70716e6578742f7265666c656374696f6e2d6170692d646f632f762f756e737461626c652e737667)](https://packagist.org/packages/opqnext/reflection-api-doc)[![License](https://camo.githubusercontent.com/3353fffa1df5e08adf059a2f2f85173f51ffe9708f60015965a9ea7953f81133/68747470733a2f2f706f7365722e707567782e6f72672f6f70716e6578742f7265666c656374696f6e2d6170692d646f632f6c6963656e73652e737667)](https://packagist.org/packages/opqnext/reflection-api-doc)

两种使用方式，1.composer安装使用。2.tp5独立安装使用。

#### composer 方式安装

[](#composer-方式安装)

1. 安装：

安装有两种方法:

直接执行:

```
composer require "opqnext/reflection-api-doc:v1.0"

```

或者修改composer.json文件

```
// 在require里加上
"opqnext/reflection-api-doc": "v1.0"

// 可以在文件末加上这个几行 这是国内的镜像下载速度较快。
// 据说每分钟同步，但是我觉得不是
"repositories": {
    "packagist": {
        "type": "composer",
        "url": "https://packagist.phpcomposer.com"
    }
}

```

我的composer.json示例:

```
{
    "name": "topthink/think",
    "description": "the new thinkphp framework",
    "type": "project",
    "keywords": [
        "framework",
        "thinkphp",
        "ORM"
    ],
    "homepage": "http://thinkphp.cn/",
    "license": "Apache-2.0",
    "authors": [
        {
            "name": "liu21st",
            "email": "liu21st@gmail.com"
        }
    ],
    "require": {
        "php": ">=5.4.0",
        "topthink/framework": "^5.0",
        "opqnext/reflection-api-doc": "v1.0_beta"
    },
    "extra": {
        "think-path": "thinkphp"
    },
    "config": {
        "preferred-install": "dist"
    },
    "repositories": {
        "packagist": {
            "type": "composer",
            "url": "https://packagist.phpcomposer.com"
        }
    }
}

```

2. 使用方法

在 application/extra 目录下创建文件名为 documents.php 的配置文件。

配置文件内容如下：

```