README

此包允许您将 API 路由导出到 Postman 导入 JSON 文件

安装

通过 composer 安装包

composer require --dev jimenezmaximiliano/laravel-postman

然后在 config/app.php 中添加服务提供者

PHP >= 5.5

JimenezMaximiliano\LaravelPostman\LaravelPostmanServiceProvider::class

PHP < 5.5

JimenezMaximiliano\LaravelPostman\LaravelPostmanServiceProvider

配置

首先，发布包配置文件

php artisan vendor:publish

注意：发布配置文件是可选的，您可以使用默认的包选项。

选项

apiURL

这是 Postman 路由的基本 URL

默认值：config('app.url')

collectionName

这是 Postman 收集的名称

默认值：命令将要求您提供

collectionDescription

这是 Postman 收集的描述

默认值：命令将要求您提供

apiPrefix

这是用于识别要导出路由的前缀

默认值：'api'

skipHEAD

这避免了为 HEAD 方法创建路由

默认值：true

exportDirectory

Postman.json 文件将导出的目录

用法

配置控制器

在您的实体控制器中添加一个属性，如下所示

public $postmanModel = 'App\MyEntityModel';

在您的模型类中添加一个公共方法，如下所示

public function getPostmanParams() { return $this->fillable; }

此参数数组将用于填充 Postman 中的 POST 和 PUT urlencoded 表单数据部分。前面的方法只是一个示例，您应该返回您希望在 Postman 中看到的参数数组。

导出

php artisan laravelPostman:export

nolikzero / laravel-postman

维护者

详细信息