PHPackages                             luckynvic/yii2-rest-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. [HTTP & Networking](/categories/http)
4. /
5. luckynvic/yii2-rest-doc

ActiveYii2-extension[HTTP & Networking](/categories/http)

luckynvic/yii2-rest-doc
=======================

Yii2 REST Documentation Generator

0.0.3-beta(9y ago)024.7k↓33.3%BSD-3-ClausePHP

Since Aug 8Pushed 9y ago1 watchersCompare

[ Source](https://github.com/luckynvic/yii2-rest-doc)[ Packagist](https://packagist.org/packages/luckynvic/yii2-rest-doc)[ Docs](https://github.com/luckynvic/yii2-rest-doc)[ RSS](/packages/luckynvic-yii2-rest-doc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (2)Versions (4)Used By (0)

yii2-rest-doc
=============

[](#yii2-rest-doc)

Yii2 rest api document generator. This extension use yii console to build rest api documentation using [php-apidoc](https://github.com/calinrada/php-apidoc).

Installation
============

[](#installation)

Installation is recommended to be done via composer by running:

```
composer require luckynvic/yii2-rest-doc "*"

```

Alternatively you can add the following to the `require` section in your `composer.json` manually:

```
"luckynvic/yii2-rest-doc": "*"
```

Run `composer update` afterwards.

Setup
=====

[](#setup)

Add to your console config

```
    'controllerMap' => [
        'build-rest-doc' => [
            'class' => '\luckynvic\restdoc\BuilderController',
            'sourceDirs' => [
                '@api/controllers', // api controller path
            ],
            'outputDir' => 'docs/rest',
            'outputFile' => 'index.html',
            //optional
            'templatePath' => dirname(__DIR__).'/../docs/rest/template/index.html',
        ],
    ],

```

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 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 ~5 days

Total

3

Last Release

3555d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/47a928ee8a58eaec5ed10e190ef0dc1da23883f8ed00ef699c4e896405aded8e?d=identicon)[luckynvic](/maintainers/luckynvic)

---

Top Contributors

[![luckynvic](https://avatars.githubusercontent.com/u/4830453?v=4)](https://github.com/luckynvic "luckynvic (6 commits)")

---

Tags

restdocumentationgeneratoryii2

### Embed Badge

![Health badge](/badges/luckynvic-yii2-rest-doc/health.svg)

```
[![Health](https://phpackages.com/badges/luckynvic-yii2-rest-doc/health.svg)](https://phpackages.com/packages/luckynvic-yii2-rest-doc)
```

###  Alternatives

[nostop8/rest-api-doc

Simple documentation generator for Yii2 REST applications based on defined API endpoints and actions annotations.

2119.3k](/packages/nostop8-rest-api-doc)[vanderlee/swaggergen

Generate Swagger/OpenAPI documentation from simple PHPdoc-like comments in PHP source code.

42127.9k3](/packages/vanderlee-swaggergen)[pahanini/yii2-rest-doc

A Yii2 tool to create slate index.md for you REST controllers.

3628.0k](/packages/pahanini-yii2-rest-doc)[tartanlegrand/laravel-openapi

Generate OpenAPI Specification for Laravel Applications

38178.7k2](/packages/tartanlegrand-laravel-openapi)[tunecino/yii2-nested-rest

Adds nested resources routing support along with related actions and relationship handlers to the Yii RESTful API framework

4815.8k](/packages/tunecino-yii2-nested-rest)

PHPackages © 2026

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