ParamsController.php

<?php
namespace App\Controller;

use Symfony\Component\HttpFoundation\Request;
use PhpRest\ApiResult;

/**
 * @path /params
 */
class ParamsController
{
    /**
     * @route GET /demo1
     */
    public function demo1($p1) 
    {
        // 最简写法 请求 <domain>/params/demo1?p1=xxx
        return "p1 = {$p1}";
    }

    /**
     * @route GET /demo2
     * @param string $p1 p1描述
     * @param string $p2 描述可不写, 默认等于参数名 p2
     * @param        $p3 参数类型可不写, 默认为 mixed
     * @param string $p4 参数默认必传,除非在function中给了默认值,参数为可选
     */
    public function demo2($p1, $p2, $p3, $p4 = 'p4') 
    {
        return "p1 = {$p1}, p2 = {$p2}, p3 = {$p3}, p4 = {$p4}";
    }

    /**
     * demo3
     * 
     * @route GET /demo3/{id}
     * @param string $token token {@bind headers.Authorization}
     */
    public function demo3(int $id, $token) 
    {
        // path参数 $id 默认是字符串
        // 如果要验证类型可以在下面加一行(注意参数必需同名)
        // @param int $id
        // 因为同时指定path参数和 get/post参数， 优先取 path参数
        // 虽然 https://github.com/nikic/FastRoute 也支持 /{id:\d+} 这样的写法
        // 但最这样的uri格式与swagger 文档冲突， 故本框架不建议那样写（不使用swagger的话就无所谓了）
        //
        // {@bind headers.token} 可从header 中取参
        // 
        // POST, PUT 请求， 参数默认为 {@bind request.xxx}
        // 其它请求， 参数默认为       {@bind query.xxx}
        // 
        // 如果 POST 请求要取get 参数 需要指定 {@bind query.xxx}
        // 同样 GET  请求要取post参数 需要指定 {@bind request.xxx}
        return "id = {$id}, token = {$token}";
    }

    /**
     * 参数校验
     * 
     * rules:
     * see https://github.com/vlucas/valitron#built-in-validation-rules
     *
     * @route GET /demo4
     * @param string    $p1   随意值
     * @param int       $p2   等同于integer
     * @param integer   $p3   p3
     * @param numeric   $p4   p4
     * @param email     $p5   p5
     * @param url       $p6   p6
     * @param alpha     $p7   p7
     * @param alphaNum  $p8   p8
     * @param slug      $p9   p9
     * @param date      $p10  p10
     * @param time      $p11  p11
     * @param dateTime  $p12  p12
     * @param ip        $p13  p13
     * @param string    $p14  p14 {@rule length=6}
     * @param int       $p15  p15 {@rule integer|min=1|max=6}
     * @param string    $p16  p16 {@rule in=red,blue,yellow}
     * @param string    $p17  p17 {@rule regex=/^1[3456789]\d{9}$/}
     */
    public function demo4($p1, $p2, $p3, $p4, $p5, $p6, $p7, $p8, $p9, $p10, $p11, $p12, $p13, $p14, $p15, $p16, $p17) {

        // @param integer  $p3  p3   等同于  @param int    $p3  p3  {@rule integer}
        // @param alpha    $p7  p7   等同于  @param string $p7  p7  {@rule alpha}
        // @param dateTime $p12 p12  等同于  @param string $p12 p12 {@rule dateFormat=Y-m-d H:i:s}
        //
        // 注意 参数校验只是通过框架验证参数规则
        // 由于php 是弱类型语言 
        // // @param int $p1
        //    function($p1)      // p1 不一定就是int型
        //    function(int $p1)  // p1 肯定是 int
        //
        // 如果只写 function(int $p1) 也会添加$p1的integer 验证规则,所以
        //  @param int $p1
        //  @param string[] $p2
        //  function($p1, $p2)
        //
        //  function(int $p1, array $p2)
        // 两种写法是一样的效果， 但是只支持 int, float, array 自动添加验证规则
        $res = [
            'p1' => $p1, // abc
            'p2' => $p2, // 1
            'p3' => $p3, // 3
            'p4' => $p4, // 64.4
            'p5' => $p5, // 15279663@qq.com
            'p6' => $p6, // http://www.163.com
            'p7' => $p7, // aa
            'p8' => $p8, // a142
            'p9' => $p9, // a1_
            'p10' => $p10, // 2020-11-11
            'p11' => $p11, // 11:11:11
            'p12' => $p12, // 2020-11-11 11:11:11
            'p13' => $p13, // 127.0.0.1
            'p14' => $p14, // aaaaaa
            'p15' => $p15, // 4
            'p16' => $p16, // red
            'p17' => $p17  // 13913181371
        ];
        // \PhpRest\dump($user); // \PhpRest\dump方法来自 ThinkPhp框架，提供更友好的浏览器输出
        return ApiResult::success($res);
    }

    /**
     * demo5
     * 
     * 使用规则模板
     * 
     * @route POST /demo5
     * @param string $p1 p1 {@rule template=code}
     */
    public function demo5($p1) 
    {   
        // 如果某个规则在很多地方都使用, 可以在config.php中定义一个模板
        // 'App.paramRules' => [ // 这个名字不能变
        //     'phone' => 'regex=/^1[3456789]\d{9}$/',
        //     'code ' => 'integer|min=1|max=6'
        // ],
        return ApiResult::success($p1);
    }

    /**
     * demo6
     * 
     * 数组参数绑定
     * 
     * @route POST /demo6
     * @param string[] $ary ary
     */
    public function demo6($ary) 
    {
        // @param string[] $ary ary  必需提交一个数组格式
        // @param int[]    $ary ary  必需提交一个全是整形的数组
        // @param ip[]     $ary ary  必需提交一个全是合法IP的数组
        // @param data[]   $ary ary  必需提交一个全是合法日期字符串的数组
        // ...
        
        // function(array $ary) 等同于 @param string[], 可以省略 @param
        return ApiResult::success($ary);
    }

    /**
     * 直接绑定 Request 对象
     * 
     * 别忘了 use Symfony\Component\HttpFoundation\Request;
     * Request: https://symfony.com/doc/current/components/http_foundation.html#request
     * 
     * @route GET /demo7
     */
    public function demo7(Request $request) 
    {
        return $request->query->all();
    }
}