README

安装

通过 composer

composer create-project alexkr/friendly [目标位置].

通过 git

• 克隆此仓库
• 运行 composer install
• 运行 composer bootstrap 或 composer run-script post-create-project-cmd

复制源代码

• 填写 config.php
• 运行 php initDatabase.php
• 使用 composer serve 启动服务器
• 享受吧！

端点

• 创建用户 - POST: /users
• 获取好友列表 - GET: /users/{%user_id%}/friends
• 获取朋友的朋友列表 - GET: /users/{%user_id%}/friendsOfFriends
• 获取 n 深度的朋友的朋友列表 - GET: /users/{%user_id%}/friendsOfFriends/{%depth%}
• 获取友谊请求 - GET: /users/{%user_id%}/friendshipRequests
• 发送友谊请求 - POST: /users/{%user_id%}/friendshipRequest 带有 POST 参数 fromUserId
• 接受友谊请求 - POST: /users/{%user_id%}/friendshipRequest 带有 POST 参数 fromUserId
• 拒绝友谊请求 - POST: /users/{%user_id%}/friendshipRequest 带有 POST 参数 fromUserId

结构

logs/   - Log output
public/ - Site configuration entry point limits what we expose
tests/  - Codeception tests
src/
    Controller/ - Route controllers
    Model/      - Data models
    Service/    - Service providers
    app.php     - Primary application
    routes.php  - Route creation 
vendor/ - Composer install directory
config.example.php  - Example application config constants

测试

在 tests/api.suite.yml 中更改 URL

运行

composer test

脚本

一些通过 composer 运行的脚本，以简化生活。

composer
        codecept  - shortcut to codecept
        test      - alias for codecept run
        cs        - alias for "phpcs --standard=PSR2 src/",
        cbf       - alias for "phpcbf --standard=PSR2 src/",
        serve     - starts test server
        bootstrap - alias to @post-create-project-cmd