Download the PHP package oyhdd/laravel-apidoc without Composer
On this page you can find all versions of the php package oyhdd/laravel-apidoc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Please rate this library. Is it a good library?
Informations about the package laravel-apidoc
自动生成在线测试接口和文档
一.安装
1.在项目根目录下执行
2.发布资源文件及配置文件
注:若文件已存在,可通过以下命令强制覆盖
文件发布成功后,会生成配置文件config/document.php,前端资源文件resources/views/vendor/document/ 和 public/vendor/document/
3.创建数据表
备注:api_doc表存储接口相关信息,api_doc_params表存储接口的测试用例
4.访问
在浏览器打开{host}/document/api 后即可访问
二.使用方法
1.控制器接口函数中按如下格式进行函数注释:
2.在routes/api.php中按如下格式配置路由:
可通过name()和group()对路由接口进行菜单栏显示时分组,其中name()是对该组路由接口进行命名,若无name(),则该组下的接口都位于一级菜单中
注意:name()中字符串参数以“.”结尾,若要自定义字符,则config/document.php中的delimiter也要同步修改
3.config/document.php中可配置相关功能
4.接口文档
- apidoc会根据函数注释自动解析为接口文档
- 请求参数、请求示例、返回示例和返回值说明可以自行填写,数据保存在api_doc表中
5.在线测试
-
填写完相关参数后,可点击运行按钮进行接口测试,支持打印函数的输出,也支持dd(),dump()等函数
- 运行成功后,可点击"保存用例"按钮保存测试用例,然后在测试用例下拉框中可看到所有的测试用例,也可以选择想要的测试用例来运行
6.回归测试
-
点击右上角的"回归测试"按钮即可进行回归测试,使用的测试用例为每个接口保存的所有测试用例
- 可通过"点击详情"按钮来查看回归测试中各测试用例的返回结果
All versions of laravel-apidoc with dependencies
PHP Build Version
Package Version
Requires
guzzlehttp/guzzle Version
^6.3
The package oyhdd/laravel-apidoc contains the following files
Loading the files please wait ....