streams/api

Laravel Streams 的一个 RESTful API。

维护者

详细信息

github.com/laravel-streams/streams-api

源代码

问题

安装: 798

依赖者: 2

建议者: 0

安全: 0

星标: 1

关注者: 4

分支: 2

开放问题: 0

类型:streams-addon

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

Requires

Requires (Dev)

MIT 069a4aa7bee11b8484566ba231a99156735796f7

  • Ryan Thompson <ryan.woop@streams.dev>

This package is auto-updated.

Last update: 2024-09-14 18:42:21 UTC

README

为 Streams 平台提供全面控制的完整功能的 API 包。

文档

此项目在 streams.dev 上有文档。

安装

composer require streams/api:1.0.x-dev

配置

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

参考

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%"]}
    ]
}

测试

php vendor/bin/phpunit tests/

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