Download the PHP package kedeemaul/yii2-apidoc without Composer
On this page you can find all versions of the php package kedeemaul/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:
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.
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-apidoc
yii2-apidoc
yii2 通过API动作方法的注释，自动生成可阅读可调试的API文档
安装
配置
1、配置到模块数组
假设我们要放到 backend 项目下
config/main.php的modules数组配置如下
2、配置需要接口文档的控制器
config/params.php配置如下
表和静态资源
将静态资源放到指定位置。相关文件放在 vendor\kedeemaul\yii2-apidoc\source
以配在 backend 项目为例，把 css 和 js 文件夹放在 backend\web 下
生成文档的备注格式
@name表示接口名称，不注释则文档不显示该接口
@uses 表示接口简介/用途等，可空
@method 表示请求方式，不注释默认为get
@author 作者姓名
@create 创建日期
@request 参数传递说明，如“参数名以*号开头表示必填”
@param 表示请求参数，可多个，后面分别跟类型、参数名，备注
@response 返回内容介绍，如“返回JSON结构体，具体键值如下”
@return 表示返回内容，可多个，后面分别跟类型、返回名，备注
配置phpstorm注释模版
示例
文档说明和示例
接口调试
All versions of yii2-apidoc with dependencies
PHP Build Version
Package Version
The package kedeemaul/yii2-apidoc contains the following files
Loading the files please wait ....