mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-12 11:40:19 +08:00
c6e1a2f02f
* 'master' of github.com:yiisoft/yii2: (79 commits) Refactored app bootstrap logic. Update authorization.md Fixes #3052: Fixed the issue that cache dependency data is not reused when `reusable` is set true start debug logging only if debug runs when bootstrap. Update finnish translation Add ODBC support to yii\db\Connection updated error handler and requirement checker links. fixed broken API links [skip ci] added more doc [skip ci] update class map. Fixes #2034: Added `ContentNegotiator` to support response format and language negotiation renamed attributes to attributeNames in model updated phpdoc Removed `Application::preload` in favor of `Application::bootstrap` Update module-debug.md Update model.md Fixes Update basics.md typo fix [skip ci] Added `HtmlResponseFormatter` and `JsonResponseFormatter` ...
API documentation generator for Yii 2
This extension provides an API documentation generator for the Yii framework 2.0.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist yiisoft/yii2-apidoc "*"
or add
"yiisoft/yii2-apidoc": "*"
to the require section of your composer.json.
Usage
This extension offers two commands:
apito generate class API documentation.guideto render nice HTML pages from markdown files such as the yii guide.
Simple usage for stand alone class documentation:
vendor/bin/apidoc api source/directory ./output
Simple usage for stand alone guide documentation:
vendor/bin/apidoc guide source/docs ./output
You can combine them to generate class API and guide doc in one place:
# first generate guide docs to allow links from code to guide you may skip this if you do not need these.
vendor/bin/apidoc guide source/docs ./output
# second generate API docs
vendor/bin/apidoc api source/directory ./output
# third run guide docs again to have class links enabled
vendor/bin/apidoc guide source/docs ./output
By default the bootstrap template will be used. You can choose a different templates with the --template=name parameter.
Currently there is only the bootstrap template available.
You may also add the yii\apidoc\commands\RenderController to your console application class map and
run it inside of your applications console app.
Creating your own templates
TDB
Using the model layer
TDB