streams/api

A RESTful API for Laravel Streams.

1.0.x-dev 2024-08-14 18:26 UTC

Requires

• justinrainbow/json-schema: ^5.2
• streams/core: ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4
• streams/testing: ^1.0

MIT

• Ryan Thompson

README

A full-featured API package for the Streams platform that gives you total control.

Documentation

This project is documented at streams.dev.

Installation

composer require streams/api:1.0.x-dev

Configuration

php artisan vendor:publish --provider=Streams\\Api\\ApiServiceProvider --tag=config

Reference

GET /api/streams
POST /api/streams
GET /api/streams/{stream}
PUT /api/streams/{stream}
PATCH /api/streams/{stream}
DELETE /api/streams/{stream}

GET /api/streams/{stream}/entries
POST /api/streams/{stream}/entries
GET /api/streams/{stream}/entries/{entry}
PUT /api/streams/{stream}/entries/{entry}
PATCH /api/streams/{stream}/entries/{entry}
DELETE /api/streams/{stream}/entries/{entry}

POST /api/streams/{stream}/query

?where[field]=value
&constraint[field]=operator
&per_page=10
&page=2
&limit=40

{
    "parameters": [
        {"method": ["argument1", "argument2"]},
        {"where": ["field", "LIKE", "%Value%"]}
    ]
}

Testing

php vendor/bin/phpunit tests/

XDEBUG_MODE=coverage php vendor/bin/phpunit tests/ --coverage-html=./coverage