assasz/gorynych-skeleton

Gorynych 骨架 API。

维护者

详细信息

github.com/Assasz/gorynych

源代码

问题

安装: 1

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 1

类型：项目

dev-master 2020-09-30 18:02 UTC

Requires

Requires (Dev)

proprietary 05bdf0911e742f31cf099dbbc6ecc2fbc190ffe9

  • Paweł Antosiak <contact.woop@pawelantosiak.com>

This package is auto-updated.

Last update: 2024-09-24 01:18:10 UTC

README

由 Gorynych 和 Doctrine ORM 驱动的 Skeleton API。

安装

通过 Composer

composer create-project assasz/gorynych-skeleton

设置数据库

# .env
DATABASE_URL='mysql://user:secret@localhost/mydb'

# creates database schema
./vendor/bin/doctrine orm:schema-tool:create

# loads fixtures for dev environment 
php bin/console gorynych:load-fixtures --env=dev

设置测试环境

# .env.test
DATABASE_URL='sqlite://${PROJECT_DIR}/var/sqlite/db_test.sqlite'
BASE_URI='https://'

API 生成器

Gorynych 为您的应用程序资源提供简单而强大的 API 生成器

php bin/console gorynych:generate-api [resourceNamespace]

使用此命令，Gorynych 将为您生成

  • 所有项目资源的 Get、Remove、Replace 操作
  • 所有集合资源的 Get、Insert 操作
  • 上述操作的 API 功能测试用例：App\Tests\Functional\Api
  • 测试固定值：config/fixtures
  • Open API 3 文档：openapi/openapi.yaml

快速演示

rm -rf src/Ports/Operation/* && rm -rf tests/Functional/Api
php bin/console gorynych:generate-api App\Application\Resource
./vendor/bin/phpunit

注意事项

  • 领域实体必须位于 src/Domain/Entity 路径下。
  • openapi/openapi.yaml 文件将始终被覆盖，因此请勿直接修改此文件 - 使用注释和以下命令以保持文档始终更新
php bin/console gorynych:update-api-docs