Download the PHP package craa/yii2-api-debugger without Composer
On this page you can find all versions of the php package craa/yii2-api-debugger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download craa/yii2-api-debugger
More information about craa/yii2-api-debugger
Files in craa/yii2-api-debugger
Download craa/yii2-api-debugger
More information about craa/yii2-api-debugger
Files in craa/yii2-api-debugger
Vendor craa
Package yii2-api-debugger
Short Description api-debugger extension for the Yii framework
License MIT
Homepage https://github.com/craa/yii2-api-debugger
Package yii2-api-debugger
Short Description api-debugger extension for the Yii framework
License MIT
Homepage https://github.com/craa/yii2-api-debugger
Please rate this library. Is it a good library?
Informations about the package yii2-api-debugger
Yii2 API Debugger
Yii2-API-Debugger 是Yii2框架下支持自动生成文档的API调试模块,使用 ReflectionClass 与 BootStrap,通过提取module``controller``action
的注释生成API菜单和文档,并且自动构建当前API请求表单,调试人员可以修改参数调用并查看返回结果。
安装
-
composer
- 手动安装
配置
然后就可以通过以下URL访问 API-Debugger:
注释规范
Yii2-API-Debugger 是建立在规范的注释上的,在使用前先了解一下支持的注释。
Module
Yii2-API-Debugger 会从Module
的注释中提取以下值:
- name 模块名称,如不填默认值为模块id
- enable 是否开启,设置为 'false' 时模块以及属下的接口将不会在菜单显示
示例:
Controller
Yii2-API-Debugger 会从Controller
的注释中提取以下值:
- name 控制器名称,如不填默认值为控制器id
- enable 是否开启,设置为 'false' 时控制器以及属下的接口将不会在菜单显示
示例:
Action
Yii2-API-Debugger 会从Action
的注释中提取以下值:
- name 接口名称,如不填默认值为ActionId
- enable 是否开启,设置为 'false' 时接口将不会在菜单显示
- method 接口请求方式,
GET
/POST
- version 支持版本,语法参考 Composer Versions
- function 接口功能描述
-
param 接口参数,该值可重复添加
格式为
@param string $uid 用户ID (123) 某某平台用户ID,10位字符串
- 参数类型:必填,例:
string
- -file- 上传文件
- int 上传文本
- string 上传文本
- 参数名称:必填,例:
$uid
- 参数简介:选填,例:
'用户ID
- 默认值:小括号里的值为参数默认值,选填,例:
(123)
- 参数详情:选填,例:
'某某平台用户ID,10位字符串
- 参数类型:必填,例:
- return 接口返回值描述,支持多行
- exception 接口异常信息描述,支持多行
示例:
All versions of yii2-api-debugger with dependencies
PHP Build Version
Package Version
Requires
yiisoft/yii2 Version
>=2.0.0
The package craa/yii2-api-debugger contains the following files
Loading the files please wait ....