README

该软件包允许您根据路由自动生成Postman集合。

安装

composer require oooiik/laravel-export-postman

配置

您可以根据导出需求修改任何export-postman.php配置值。

API注释的PHP注释文档

身份验证

@AuthNo 注释的API端点不需要身份验证。

@AuthParent 从父端点继承身份验证设置。

@AuthBearer [token] 需要Bearer令牌身份验证。将[token]替换为实际令牌。示例

@AuthBearer abc123

头部

@Header [key] => [value] 为API请求指定自定义头部。将[key]替换为头部名称，将[value]替换为头部值。

@Header Accept => application/json
@Header Content-Type => application/json

描述

@DescriptionContext [context] 提供API请求的简要描述或上下文。将[context]替换为描述。

@DescriptionBasePath [path] 指定API端点的基准路径描述。将[path]替换为基准路径。示例

@DescriptionBasePath /dir/file

@DescriptionResourcePath [path] 指定API端点的资源路径描述。将[path]替换为资源路径。

请求前脚本

@PreRequestScriptContext [path] 定义在API请求之前执行的请求前脚本。将[path]替换为脚本上下文或位置。

@PreRequestScriptFileBasePath [path] 指定包含请求前脚本的文件的基准路径。将[path]替换为相对于基本目录的文件位置。

@PreRequestScriptFileResourcePath [path] 指定包含请求前脚本的文件的资源路径。将[path]替换为特定的文件位置。

测试脚本

@TestScriptContext [context] 定义在API请求之后执行的测试脚本。将[context]替换为测试脚本上下文或描述。

@TestScriptFileBasePath [path] 指定包含测试脚本的文件的基准路径。将[path]替换为相对于基本目录的文件位置。

@TestScriptFileResourcePath [path] 指定包含测试脚本的文件的资源路径。将[path]替换为特定的文件位置。

示例

class Container ...
{
    /**
     * @AuthNo
     * @Header Accept => application/json
     * @DescriptionContext description for postman
     * @PreRequestScriptContext console.log('pre-request index method') 
     * @TestScriptContext console.log('test index method') 
     */
    public function index(...) {...}
    
    /**
     * @AuthBearer {{TOKEN}}
     * @PreRequestScriptFileBasePath ./dir/filename
     * @TestScriptFileResourcePath ./dir/filename
     */
    public function Show(...) {...}
}

使用方法

php artisan export:postman