README

《playground-matrix-api》Laravel包。

此包提供与Playground Matrix交互的API，这是一个项目管理与任务系统。

如果您需要用户界面，请使用Playground Matrix Resource，它提供了一个Blade UI。

文档

在Read the Docs：Playground文档中了解更多关于使用Playground Matrix API的信息。

Postman

在仓库中提供了Postman集合：postman-playground-matrix-api.json。

• 您可以在Postman：GammaMatrix Playground工作空间中查看此集合。

Swagger

此应用程序提供Swagger文档：swagger.json。

• 端点模型支持锁定、强制删除回收站、恢复、版本等。
• 索引端点支持高级查询过滤。

Swagger API文档使用npm构建。

• npm仅用于生成文档，操作MATRIX API不需要npm。

请参阅package.json的要求。

安装npm。

npm install

构建文档以生成swagger.json配置。

npm run docs

文档

• 在Swagger Editor UI上预览swagger.json。
• 在Redocly Editor UI上预览swagger.json。

安装

您可以通过Composer安装此包

composer require gammamatrix/playground-matrix-api

artisan about

Playground在artisan about命令中提供信息。

配置

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="Playground\Matrix\Api\ServiceProvider" --tag="playground-config"

默认情况下，所有路由都是启用的。您可以通过环境变量或配置来禁用它们。

查看已发布的配置文件内容：config/playground-matrix-api.php

您可以使用以下命令发布路由文件

php artisan vendor:publish --provider="Playground\Matrix\Api\ServiceProvider" --tag="playground-routes"

• 路由将发布在routes/playground-matrix-api文件夹中

环境变量

如果您无法或不想发布此包的配置文件，您可以通过系统环境变量来覆盖这些选项。

有关环境变量的信息可在该包的维基上找到

迁移

此包需要playground-matrix Laravel包中的迁移。

Cloc

composer cloc

➜  playground-matrix-api git:(feature/GH-3) ✗ composer cloc
> cloc --exclude-dir=node_modules,output,vendor .
     657 text files.
     637 unique files.
      21 files ignored.

github.com/AlDanial/cloc v 1.98  T=0.83 s (769.0 files/s, 124350.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                             6              0              0          56264
PHP                            462           3480           5704          20678
YAML                           162              5              0          16472
XML                              3              0              7            215
Markdown                         3             52              1            118
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                           637           3540           5712          93759
-------------------------------------------------------------------------------

PHPStan

在第9级进行测试

• config/
• database/
• routes/
• src/
• tests/Feature/
• tests/Unit/

composer analyse

编码标准

composer format

测试

composer test

变更日志

请参阅变更日志获取最近变更的详细信息。