Skip to content

inherelab/qin-skeleton

Repository files navigation

php micro skeleton

License Latest Stable Version

mongodb support

  • before require install ext-mongodb
composer require mongodb/mongodb

相关项目

  • swagger-php 用于生成 swagger.json 文档。
  • swagger-ui api 文档展示
  • codeception 测试框架(已经包含了 phpunit)

数据存储

  • mysql
  • mongodb
  • redis
  • memcache

一、应用

WEB 应用

  • 入口文件 web/index.php
  • web控制器默认放在 app/Controllers 目录

CLI 应用

  • 入口文件 bin/console
  • 命令行控制器放在 app/Console 目录

执行:php bin/console 查看更多信息

nginx 配置

resources/server-configs

问题

二、 swagger-php

推荐全局安装:

composer require --global zircote/swagger-php

使用

vendor/bin/swagger --output web/docs

三、 swagger 文档

swagger

swagger 2.0 定义 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

swagger-ui 下载

拷贝 dist 下的所有文件到项目目录下 swagger-ui 目录

文档生成

安装 zircote/swagger-php

composer global require zircote/swagger-php // 全局
composer require --dev zircote/swagger-php // 当前项目
// 扫描当前文件夹下所有目录
vendor/bin/swagger --output web/docs
// 指定扫描一个或多个目录
vendor/bin/swagger --output web/docs [dirs ...]

文档查看

  • 运行服务器(只能在内网查看)
./bin/dev-server
  • 访问: 127.0.0.1:8066

四、 codeception 测试

codeception:

分为三类:

  • acceptance 验收测试
  • functional 功能测试
  • unit 单元测试

初始化

将会创建基本的目录和配置文件

codecept bootstrap

运行测试

运行流程:

tests/_boot.php -> {suite}/_boot.php -> boot/web.php
codecept run --steps [--no-ansi]

php5

php5 $(which codecept5.phar) run --steps [--no-ansi -vvv]
// 只运行单元测试
php5 $(which codecept5.phar) run unit

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published