README

playground-lead-api Laravel包。

此包提供与Playground Lead（一项营销销售管理工具）交互的API。

如果您需要UI，请使用Playground Lead Resource，它提供Blade UI。

文档

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

文档

Swagger

此应用程序提供Swagger文档：[swagger.json](https://github.com/gammamatrix/playground-lead-api/blob/HEAD/swagger.json)。

端点模型支持锁定、强制删除垃圾、恢复、版本等。
索引端点支持高级查询筛选。

Swagger API文档是用npm构建的。

npm仅用于生成文档，运行Lead API时不需要。

查看[package.json要求](https://github.com/gammamatrix/playground-lead-api/blob/HEAD/package.json)。

安装npm。

npm install

构建文档以生成[swagger.json配置](https://github.com/gammamatrix/playground-lead-api/blob/HEAD/swagger.json)。

npm run docs

文档

在Swagger Editor UI上预览[swagger.json](https://editor.swagger.io/?url=https://raw.githubusercontent.com/gammamatrix/playground-lead-api/develop/swagger.json)。
在Redocly Editor UI上预览[swagger.json](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/gammamatrix/playground-lead-api/develop/swagger.json)。

安装

您可以通过composer安装此包

composer require gammamatrix/playground-lead-api

配置

默认情况下，所有选项均已禁用。

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

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

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

Cloc

composer cloc

➜  playground-lead-api git:(feature/GH-1) ✗ composer cloc
> cloc --exclude-dir=node_modules,output,vendor .
     618 text files.
     446 unique files.
     173 files ignored.

github.com/AlDanial/cloc v 1.98  T=0.61 s (725.4 files/s, 117450.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                             5              0              0          35543
PHP                            322           2433           3998          16335
YAML                           112              5              0          13544
XML                              3              0              7            215
Markdown                         3             37              0             85
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                           446           2478           4005          65734
-------------------------------------------------------------------------------

PHPStan

在第9级对

config/
routes/
src/
tests/Feature/
tests/Unit/

composer analyse

编码标准

composer format

测试

composer test --parallel

更改日志

有关最近更改的更多信息，请参阅CHANGELOG。

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。

gammamatrix / playground-lead-api

维护者

详细信息