README

Vasara（芬兰语：锤子）提取 Rest API JSON 文件，方便用户访问并忽略未使用元素。

入门

此包仅适用于 Laravel（尚未测试 Lumen）。将单个 Rest API JSON 文件提取到对象中。将值分别分离到 info 和 routes。

Rest API JSON 文件

目前仅支持 Postman 文件。我们将在未来更新支持其他 JSON 文件。

安装

在 composer.json 中添加此包，并运行 composer update（或直接运行 composer require dyned/vasara）。

composer require dyned/vasara

更新 composer 后，将 ServiceProvider 添加到 config/app.php 中的 providers 数组

DynEd\Vasara\VasaraServiceProvider::class

您需要发布此包的配置文件。这将添加 config/vasara.php 文件，您可以在其中配置此包。

$ php artisan vendor:publish --provider="DynEd\Vasara\VasaraServiceProvider" --tag=config

用法

使用 JSON 内容实例化一个 vasara 对象。

$vasara = new Vasara($json);

或者

您可以通过 Laravel File Facades 直接访问文件来创建它。

$file = File::get('/path/to/postman/json/file.json');

$vasara = new Vasara($file);

使用正确的 URL 更改 URL 的主机

$vasara->changeHost('https://:8181');

告诉 vasara 从 JSON 文件中收集所有数据

$vasara->run();

检查 Postman 路由是否存在以返回 Laravel abort 函数。

if ( ! $vasara->routeExist()) {
    abort(404, 'Route not found');
}

从 JSON 中检索所有路由。

$vasara->getRoutes();

其他功能

• 检索所有信息。

  $vasara->getInfo();
  

返回值

Collection {#2343 ▼
  #items: array:18 [▼
    0 => {#200 ▼
      +"name": "[Auth] Login"
      +"description": "Retrieve user token"
      +"method": "POST"
      +"header": "[]"
      +"body": "{"email":"email@example.com","password":"secret"}"
      +"url": {#2344 ▼
        +"host": "https://:8000"
        +"path": "auth/login"
        +"full": "https://:8000/auth/login"
      }
    }
    1 => {#2345 ▶}
    2 => {#2347 ▶}
    3 => {#2349 ▶}
    4 => {#2351 ▶}
    5 => {#2353 ▶}
    6 => {#2355 ▶}
    7 => {#2357 ▶}
    8 => {#2359 ▶}
    9 => {#2361 ▶}
    10 => {#2363 ▶}
    11 => {#2365 ▶}
    12 => {#2367 ▶}
    13 => {#2369 ▶}
    14 => {#2371 ▶}
    15 => {#2373 ▶}
    16 => {#2375 ▶}
    17 => {#2377 ▶}
  ]
}

作者

• Sabar Tampubolon - 初始工作 - stampubolon

所有者

此包代表 DynEd International, Inc 发布。

许可证

此项目采用 MIT 许可证 - 有关详细信息，请参阅 LICENSE.md 文件。