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

ActiveYii2-extension[API Development](/categories/api)

yangsl/apidoc
=============

yii2-apidoc

v1.0.8(7y ago)020MITPHP

Since Apr 6Pushed 7y ago1 watchersCompare

[ Source](https://github.com/yangsl2014/apidoc)[ Packagist](https://packagist.org/packages/yangsl/apidoc)[ RSS](/packages/yangsl-apidoc/feed)WikiDiscussions master Synced 4d ago

READMEChangelog (3)DependenciesVersions (4)Used By (0)

apidoc
======

[](#apidoc)

yii2 apidoc

根据注释或者定义的对象文件生成接口文档。

yii2 basic版本 测试通过 yii2 advance版本 测试通过

Installation
------------

[](#installation)

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

```
composer require yangsl/apidoc

```

config add to modules

```
    'api-document' => [
        'class' => 'yangsl\apidoc\Module',
        'defaultRoute' => 'default', //默认控制器
        'appFolder' => 'admin',
        'appControllers' => true, //是否检测app\controllers命名空间下的控制器
        'modules' => [  //需要生成文档的模块命名空间
            'app\modules\test\Module',
        ],
    ],

```

访问

```
http://domain/api-document

```

注释

```
    /**
     * 这是一个测试的Api
     * @desc 列举所有的注释格式
     *
     * @param string $user_type |用户类型|true||其他说明|
     * @param int $sex |性别|true|0|0:不限 1:男 2:女|
     *
     * @return int status 操作码，0表示成功
     * @return string msg 提示信息
     * @return array list 用户列表
     * @return int list[].id 用户ID
     * @return string list[].name 用户名字
     *
     * @exception 400 参数传递错误
     * @exception 500 服务器内部错误
     */

```

or

```
    /**
     * 这是一个测试的Api
     * @desc 列举所有的注释格式
     *
     * @apidoc \app\structs\DemoRequest
     *
     * @exception 400 参数传递错误
     * @exception 500 服务器内部错误
     */

```

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~61 days

Total

3

Last Release

2840d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c84c6b8f983bb7715fc146d6da0175a27ad5a3840cf130d388a14f29a751fa5b?d=identicon)[yangsl2018](/maintainers/yangsl2018)

---

Top Contributors

[![self-heal](https://avatars.githubusercontent.com/u/9592032?v=4)](https://github.com/self-heal "self-heal (30 commits)")

### Embed Badge

![Health badge](/badges/yangsl-apidoc/health.svg)

```
[![Health](https://phpackages.com/badges/yangsl-apidoc/health.svg)](https://phpackages.com/packages/yangsl-apidoc)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)