PHPackages                             pkg6/apidoc - 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. pkg6/apidoc

ActiveLibrary[API Development](/categories/api)

pkg6/apidoc
===========

Generate documentation for php API based application. No dependency. No framework required.

v0.1.0(11mo ago)02MITPHPPHP >=5.4

Since May 25Pushed 11mo agoCompare

[ Source](https://github.com/pkg6/php-apidoc)[ Packagist](https://packagist.org/packages/pkg6/apidoc)[ RSS](/packages/pkg6-apidoc/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)DependenciesVersions (2)Used By (0)

PHP-ApiDoc
==========

[](#php-apidoc)

**为基于 PHP 的 API 应用生成文档**无需依赖框架，无需额外依赖。

---

📋 环境要求
------

[](#-环境要求)

- PHP >= 5.3.2

📦 安装
----

[](#-安装)

使用 Composer 安装：

```
composer require pkg6/apidoc

```

🚀 使用方法
------

[](#-使用方法)

在你的类和方法上使用注解：

```
namespace Pkg6\Apidoc\Tests\TestClasses;

class User
{
    /**
     * @ApiDescription(section="User", description="获取用户信息")
     * @ApiMethod(type="get")
     * @ApiRoute(name="/user/get/{id}")
     * @ApiParams(name="id", type="integer", nullable=false, description="用户ID")
     * @ApiParams(name="data", type="object", sample="{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}")
     * @ApiReturnHeaders(sample="HTTP 200 OK")
     * @ApiReturn(type="object", sample="{
     *   'transaction_id':'int',
     *   'transaction_status':'string'
     * }")
     */
    public function get() {}

    /**
     * @ApiDescription(section="User", description="创建新用户")
     * @ApiMethod(type="post")
     * @ApiRoute(name="/user/create")
     * @ApiParams(name="username", type="string", nullable=false, description="用户名")
     * @ApiParams(name="email", type="string", nullable=false, description="邮箱")
     * @ApiParams(name="password", type="string", nullable=false, description="密码")
     * @ApiParams(name="age", type="integer", nullable=true, description="年龄")
     */
    public function create() {}
}

```

⚙️ 生成 API 文档
------------

[](#️-生成-api-文档)

```