Download the PHP package xwpd/thinkphp-apidoc-generator without Composer

On this page you can find all versions of the php package xwpd/thinkphp-apidoc-generator. 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 thinkphp-apidoc-generator

ThinkPHP api文档自动生成

支持

thinkphp5.1.*

自动生成的效果

安装

  1. 安装依赖

  2. 添加命令
    打开配置文件 application/command.php 添加如下内容

使用

  1. 复制语言文件
    将 vendor/yunbuye/thinkphp-apidoc-generator/resources/lang/zh-cn.php 文件复制到 application/lang/zh-cn.php 。
    不复制的话,将会没有对应的描述。
  2. 运行命令 生成文档

  3. 其他参数
    运行下面命令查看

功能

  1. 分组

    • 在控制器头部,其他注释之后添加注释 @resource 拥有下面注释的控制器的操作都会会分到 例子 的这个组里
  2. 控制器操作 操作的文档生成说明

    例子

  3. 请求参数自动生成
    在控制器操作里,依赖注入请求验证,会自动生成参数文档。
    但是表单验证类,必须继承 Yunbuye\ThinkApiDoc\FormValidate 而且必须在控制器方法内注入。
    例:(其中 app\common\validate\Save 继承了 Yunbuye\ThinkApiDoc\FormValidate)

    这样生成文档时,即可自动根据表单验证生成参数说明

  4. 自定义错误信息(描述)
    生成文档时,如果对应规则有自定义错误信息,将会被使用。

Thanks

https://github.com/mpociot/laravel-apidoc-generator

License

MIT license.


All versions of thinkphp-apidoc-generator with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6.0
fzaninotto/faker Version ~1.0
topthink/framework Version 5.1.*
mpociot/reflection-docblock Version ^1.0
ramsey/uuid Version ^3.0
terranc/think-blade Version ^1.1
doctrine/inflector Version ^1.3
mnapoli/front-yaml Version 1.6.*
topthink/think-helper Version ^1.0
ext-json 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 xwpd/thinkphp-apidoc-generator contains the following files

Loading the files please wait ....