README

一个最小化的项目，允许您快速创建基于Symfony的新API项目，并使用以下有用的工具：swagger、standard-version、php-cs-fixer、phpstan、phpunit、docker、xdebug和我的启动脚本。它已准备好支持使用Visual Studio Code进行调试 - 只需查看.env.local ;）。

为什么？

https://github.com/patrykbaszak/skeleton#why

如何开始

为您的项目创建目录，进入（cd {您的目录}）并运行命令

composer create-project pbaszak/api-skeleton . --no-interaction

（每次）使用此命令启动本地环境

bash start.sh

然后，您的本地环境就准备好了，可以使用有用的工具开发API应用程序。

检查 https://:8080/api/doc！

如何使用 Standard Version

如果您没有node_modules目录，请运行

npm install

首次发布

npm run version:first-release

主版本、次版本、修订版本更新

npm run version:major
# or
npm run version:minor
# or
npm run version:patch

推送标签

npm run version:release
# or
npm run release

检查 package.json 以了解命令的功能。

如何使用 PHPStan

主要命令

docker exec php composer code:analyse

但，如果您需要将错误添加到忽略列表中

docker exec php composer code:analyse:b

如何使用 PHP CS Fixer

docker exec php composer code:fix

如何在 Visual Studio Code 中使用 XDebug

在您的项目中创建新文件：.vscode/launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for xDebug",
            "type": "php",
            "request": "launch",
            "port": 5902,
            "hostname": "0.0.0.0",
            "pathMappings": {
                "/app/": "${workspaceRoot}"
            }
        }
    ]
}

取消注释.env.local中的环境

XDEBUG_MODE=develop,debug
XDEBUG_CONFIG=" client_port=5902 idekey=VSCODE client_host=host.docker.internal discover_client_host=0 start_with_request=yes"

按Ctrl + Shift + D并运行监听xDebug。

pbaszak / api-skeleton

维护者

详细信息