luisj / postman-collection-viewer

v1.0.13 2024-07-23 17:42 UTC

Unknown License

• Luis Jesus

Published on Packagist.org on 2024-07-23 17:43 UTC

README

Postman Collection Viewer es un paquete PHP que se integra perfectamente con Laravel para renderizar la documentación de una API. Carga una colección JSON exportada desde Postman y la muestra en una vista blade.

Instalación

Instalacion del paquete con composer:

composer require luisj/postman-collection-viewer

Publicar los archivos css y js de la vista blade:

php artisan vendor:publish --provider="Luisj\PostmanCollectionViewer\PostmanCollectionViewerServiceProvider" --tag=public

Instrucciones de uso

Primero debes de exportar la collecion de postman dentro de alguna carpeta en tu proyecto, para poder renderizarla de la siguente forma:

use \Luisj\PostmanCollectionViewer\Facades\PostmanCollectionViewer;

$path_collection = base_path() . "/resources/postman/postman_collection.json";

return PostmanCollectionViewer::loadCollection($path_collection)->renderView();

Tambien se puede cargar el enviroment

$path_collection = base_path() . "/resources/postman/postman_collection.json";
$path_enviroment = base_path() . "/resources/postman/postman_environment.json";

return PostmanCollectionViewer::loadCollection($path_collection)
       ->loadEnviroment($path_enviroment)
       ->renderView();