phpRest2-example/App/Controller/ParamsController.php at main · nirvana72/phpRest2-example · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?php
declare(strict_types=1);

namespace App\Controller;

use PhpRest2\Controller\Attribute\{Controller, Action, Summary, Param};
use PhpRest2\ApiResult;
use Symfony\Component\HttpFoundation\Request;

#[Controller('/params')]
class ParamsController
{
    /***************************************************************************************
     *
     **************************************************************************************/
    #[Action('GET:/demo1')]
    public function demo1($p1)
    {
        return "p1 = {$p1}";
    }

    /***************************************************************************************
     * 参数类型 两处都可以指定
     *
     * #[Param(name: 'p1', type: 'string')]
     * 或
     * public function demo2(string $p1)
     *
     * 两处都不写则默认为 mixed
     **************************************************************************************/
    #[Action('GET:/demo2')]
    #[Summary('第二个示例', desc: '主要演示参数注解的使用')]
    #[Param(name: 'p1', type: 'string', desc: 'p1描述')]
    #[Param(name: 'p2', type: 'int', desc: '描述可不写, 默认等于参数名 p2')]
    #[Param(name: 'p3', desc: '数类型可不写, 默认为 mixed')]
    #[Param(name: 'p4', type: 'string', desc: '参数默认必传,除非在function中给了默认值,参数为可选')]
    public function demo2($p1,  $p2,  $p3,  $p4 = 'p4')
    {
        return ApiResult::success([
            'p1' => $p1,
            'p2' => $p2,
            'p3' => $p3,
            'p4' => $p4,
        ]);
    }

    /***************************************************************************************
     * 参数绑定不同来源
     **************************************************************************************/
    #[Action('GET:/demo3/{id}')]
    #[Param(name: 'token', bind: 'headers.Authorization')]
    public function demo3(int $id, $token)
    {
        return ApiResult::success([
            'id' => $id,
            'token' => $token,
        ]);
    }

    /***************************************************************************************
     * 参数校验
     **************************************************************************************/
    #[Action('POST:/demo4')]
    #[Summary('参数校验')]
    #[Param(name: 'p1',  type: 'string', desc: '随意值')]
    #[Param(name: 'p2',  type: 'int')]
    #[Param(name: 'p3',  type: 'float')]
    #[Param(name: 'p4',  rule: 'numeric')]
    #[Param(name: 'p5',  rule: 'email')]
    #[Param(name: 'p6',  rule: 'url')]
    #[Param(name: 'p7',  rule: 'alpha')]
    #[Param(name: 'p8',  rule: 'alphaNum')]
    #[Param(name: 'p9',  rule: 'slug')]
    #[Param(name: 'p10', rule: 'date')]
    #[Param(name: 'p11', rule: 'dateFormat=H:i:s')]
    #[Param(name: 'p12', rule: 'ip')]
    #[Param(name: 'p13', type: 'string', rule: 'lengthBetween=4,6')]
    #[Param(name: 'p14', type: 'string', rule: 'length=6')]
    #[Param(name: 'p15', type: 'int', rule: 'integer|min=3|max=6')]
    #[Param(name: 'p16', type: 'string', rule: 'in=red,blue,yellow')]
    #[Param(name: 'p17', rule: '/^1[3456789][0-9]{9}$/')]
    public function demo4($p1, $p2, $p3, $p4, $p5, $p6, $p7, $p8, $p9, $p10, $p11, $p12, $p13, $p14, $p15, $p16, $p17)
    {
        // https://github.com/vlucas/valitron#built-in-validation-rules
        $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, // 127.0.0.1
            'p13' => $p13, // abcde
            'p14' => $p14, // aaaaaa
            'p15' => $p15, // 4
            'p16' => $p16, // red
            'p17' => $p17  // 13913181371
        ];

        return ApiResult::success($res);
    }

    /***************************************************************************************
     * 数组参数绑定
     **************************************************************************************/
    #[Action('POST:/demo5')]
    #[Summary('数组参数绑定')]
    #[Param(name: 'ary1', type: 'string')]
    #[Param(name: 'ary2', type: 'int')]
    public function demo5(array $ary1, array $ary2, array $ary3)
    {
        return ApiResult::success([
            'ary1' => $ary1,
            'ary2' => $ary2,
            'ary3' => $ary3,
        ]);
    }

    /***************************************************************************************
     * Request: https://symfony.com/doc/current/components/http_foundation.html#request
     **************************************************************************************/
    #[Action('POST:/demo6')]
    #[Summary('直接绑定request')]
    public function demo6(Request $request)
    {
        $p1 = $request->request->get('p1');
        $p2 = $request->request->get('p2');
        $p3 = $request->query->get('p3');
        return ApiResult::success([
            'p1' => $p1,
            'p2' => $p2,
            'p3' => $p3,
        ]);
    }
}