netojose/laravel-api-explorer

laravel应用程序的API探索器

2.0.1 2019-12-12 11:28 UTC

This package is auto-updated.

Last update: 2024-08-28 09:12:48 UTC


README

Latest Version on Packagist Total Downloads

交互式Laravel API探索器。您不需要为您的API编写/更新文档。动态地,您的API文档将始终以交互方式可用。

功能

  • 快速安装(一键安装,无需更改代码);
  • 无需配置;
  • 存储任何时间都可以使用的配置/参数;
  • 变量:您可以为任何位置(如查询字符串、头部、主体等)设置变量(如id、令牌等);
  • 全局头部:您可以为所有请求设置全局头部(如令牌、内容类型等)。

实时演示

https://laravel-api-explorer-demo.herokuapp.com/api-explorer

使用变量

您可以点击右上角的图标(扳手)并添加您的变量。当您需要设置一些查询字符串参数、头部值、主体内容等时,您可以使用${VARIABLE_NAME},此占位符将被您的变量替换。

使用全局头部

如果您的API需要在所有请求(或几乎所有请求)中添加某些头部,您可以设置全局头部而不是为每个请求创建这些头部。您可以点击右上角的图标(扳手)并添加全局头部。

屏幕截图

路由列表

Routes list

路由信息

Route info

请求/响应

Request/response

响应信息

Response info

安装

通过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报告,而不是使用问题跟踪器。