almahari / laravel-api-explorer
laravel应用程序的API探索器
2.0.3
2021-02-22 04:42 UTC
README
交互式Laravel API探索器。您无需为API编写/更新文档。您的API文档将始终以交互方式即时可用。
功能
- 快速安装(一步安装,无需更改代码);
- 零配置需求;
- 存储任何时间可用的配置/参数;
- 变量:您可以为任何地方设置变量(如id、令牌等,用于查询字符串、头部、主体等);
- 全局头部:您可以为所有请求设置全局头部(如令牌、内容类型等)。
实时演示
https://laravel-api-explorer-demo.herokuapp.com/api-explorer
使用变量
您可以点击右上角的图标(扳手)并添加您的变量。当您需要设置一些查询字符串参数、头部值、主体内容等时,您可以使用${VARIABLE_NAME}
,这个占位符将被您的变量替换。
使用全局头部
如果您的API需要在所有请求中包含某些头部(或几乎所有请求),则可以设置全局头部而不是为每个请求创建这些头部。您可以通过点击右上角的图标(扳手)并添加您的全局头部来实现。
屏幕截图
路由列表
路由信息
请求/响应
响应信息
安装
通过Composer
$ composer require netojose/laravel-api-explorer
使用
您只需要访问 yourdomain.com/api-explorer
配置
可选地,您可以复制配置文件以覆盖默认包配置
php artisan vendor:publish --provider="NetoJose\LaravelApiExplorer\LaravelApiExplorerServiceProvider"
现在您的项目中有一个 config/laravelapiexplorer.php
文件,您可以进行更改。可用的配置
贡献
有关详细信息,请参阅contributing.md以及待办事项列表。
安全
如果您发现任何与安全相关的问题,请通过电子邮件 sputinykster@gmail.com 而不是使用问题跟踪器。