Download the PHP package badcat/yii2-api-doc without Composer

On this page you can find all versions of the php package badcat/yii2-api-doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package yii2-api-doc

yii2-api-doc

一个针对yii2 restful API的扩展插件 (https://github.com/lrj525/yii2-api-doc)

在项目中配置该扩展后,通过读取Controller类中的特定信息,自动生成API说明文档,并可在线进行查看。

Installation

首选安装方式 composer.

执行

或者把

添加到composer.json中,通过composer install 进行安装

使用方式

1. 项目配置

在配置文件中加入

2. 生成文档所需特定信息

Module类配置

在类注释中使用@desc对Module类进行标注,程序会读取@desc的内容,暂只支持读取一行上的内容。

示例

Controller类配置

在类注释中使用@desc对Controller类进行标注,程序会读取@desc的内容,暂只支持读取一行上的内容。

示例

Controller类中的action配置

在Controller类中的action方法中使用以下方法进行标注。

3. 生成文档

把项目使用自己擅长的方式部署后,访问:http://{您的域名}/yii2apidoc/ 打开

4. 查看结果

访问:http://{您的域名}/{Module名称}/index.html

5. 最终效果

图1

图2

图3


All versions of yii2-api-doc with dependencies

PHP Build Version
Package Version
Requires yiisoft/yii2 Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package badcat/yii2-api-doc contains the following files

Loading the files please wait ....