Download the PHP package ibunao/yii2-apidoc without Composer

On this page you can find all versions of the php package ibunao/yii2-apidoc. 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?

Example code of ibunao/yii2-apidoc

Informations about the package yii2-apidoc

安装

配置

配置到模块数组

假设我们要放到 backend 项目下

配置需要接口文档的控制器

表和静态资源

剩下的需要设置的就是创建一个表用来存储文档编辑部分数据，还有就是将静态资源放到指定位置。相关文件放在 vendor\ibunao\yii2-apidoc\source

  1. 需要创建表的sql看 document_api.sql 文件
  2. 以配在 backend 项目为例，把 css 和 js 文件夹放在 backend\web 下

为什么不用资源发布和数据库迁移？
不想费劲

生成文档的备注格式

@name表示接口名称，不注释则文档不显示该接口

@uses表示接口简介/用途等，可空

@method表示请求方式，不注释默认为get

@param表示请求参数，可空可多个，后面分别跟类型、参数名，备注

@author表示接口作者/负责人，可空

apidoc4

示例

首页

apidoc3

可以编辑文档说明和示例

apidoc5

接口调试

apidoc6

All versions of yii2-apidoc with dependencies

PHP Build Version
Package Version
Requires php Version >=5.2
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 ibunao/yii2-apidoc contains the following files

Loading the files please wait ....