anomaly/streams-api

A RESTful API for Laravel Streams.

dev-develop / 1.1.x-dev 2022-02-24 16:29 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

Configuration

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

Endpoints

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

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

?q={"where": [["id", "LIKE", "%doc%"]]}
?q={"orderBy": [["name", "asc"]]}