Версія 8.1 додана 2024/05/08 17:45 автором Ashterix
Показати останніх авторів
1 {{box cssClass="floatinginfobox" width="400px" title="**Зміст**"}}
2 {{toc/}}
3 {{/box}}
4
5 = Крок 0: Налаштування composer.json =
6
7 Для того, щоб при додаванні пакету, ваш Symfony Flex автоматично зробив всі необхідні налаштування, потрібно внести наступні зміни в ваш {{code language="none"}}composer.json{{/code}}
8
9 {{code language="json"}}
10 {
11 "extra" : {
12 "symfony": {
13 "endpoint": [
14 "https://api.github.com/repos/ufo-tech/recipes/contents/index.json?ref=main",
15 "flex://defaults"
16 ]
17 }
18 },
19 }
20 {{/code}}
21
22 {{info}}
23 Детально про Symfony Flex в [[документації Symfony>>url:https://symfony.com/doc/current/setup/flex_private_recipes.html]]
24 {{/info}}
25
26 = =
27
28 = =
29
30 = Крок 1: Встановлення =
31
32 В консолі в теці проєкту виконайте цю команду, щоб завантажити останню версію цього пакету:
33
34 {{code language="bash"}}
35 composer require ufo-tech/json-rpc-bundle
36 {{/code}}
37
38 {{info}}
39 Ця команда актуальна якщо ви встановили Composer глобально, як описано в [[документації>>https://getcomposer.org/doc/00-intro.md]] Composer.
40 {{/info}}
41
42 = =
43
44 = =
45
46 = Крок 2: Реєстрація пакету =
47
48 Переконайтесь, що пакет автоматично зареєструвався в файлі {{code language="none"}}config/bundles.php{{/code}} вашого проєкту:
49
50 {{code language="php"}}
51 <?php
52 // config/bundles.php
53
54 return [
55 // ...
56 Ufo\JsonRpcBundle\UfoJsonRpcBundle::class => ['all' => true],
57 // ...
58 ];
59
60 {{/code}}
61
62 = =
63
64 = =
65
66 = Крок 3: Додавання параметрів =
67
68 {{warning}}
69 **Якщо ви виконали «Крок 0», це налаштовано автоматично і ви можете пропустити цей крок.**
70 {{/warning}}
71
72 В разі ручного налаштування бандлу, додайте (% id="cke_bm_4952S" style="display:none" %) (%%)до папки {{code language="none"}}config/packages{{/code}} файл {{code language="none"}}ufo_json_rpc.yaml{{/code}} із таким вмістом:
73
74 {{code language="yaml"}}
75 # config/packages/ufo_json_rpc.yaml
76 ufo_json_rpc:
77 security:
78 protected_methods: ['GET', 'POST'] # protection of GET and POST requests
79 token_key_in_header: 'Ufo-RPC-Token' # Name of the key in the header
80 clients_tokens:
81 - 'ClientTokenExample' # hardcoded token example. Importantly!!! Replace or delete it!
82 - '%env(resolve:UFO_API_TOKEN)%' # token example from .env.local
83
84 # Configuration for API documentation
85 docs:
86 # Optional response details
87 response:
88 key_for_methods: services # Key used to map services for API methods
89 # Information about validations
90 validations:
91 json_schema: false # Indicates if JSON-schema is used for method validation
92 symfony_asserts: false # Indicates if an array of Symfony validation constraints is used
93
94 {{/code}}
95
96 (% class="wikigeneratedid" %)
97 Детальний огляд параметрів налаштування доступний в розділі [[Налаштування бандлу>>doc:docs.JsonRpcBundle.config]]
98
99 = Крок 4: Реєстрація маршрутів =
100
101 {{warning}}
102 **Якщо ви виконали «Крок 0», це налаштовано автоматично і ви можете пропустити цей крок.**
103 {{/warning}}
104
105 (% id="cke_bm_19449S" style="display:none" %) (%%)В разі ручного налаштування бандлу, додайте (% id="cke_bm_4952S" style="display:none" %) (%%)до папки {{code language="none"}}config/routes{{/code}} файл {{code language="none"}}ufo_json_rpc.yaml{{/code}} із таким вмістом:
106
107 {{code language="yaml"}}
108 # config/routes/ufo_json_rpc.yaml
109 ufo_json_rpc:
110 resource: ../../vendor/ufo-tech/json-rpc-bundle/config/router.yaml
111 prefix: /api
112 trailing_slash_on_root: false
113 {{/code}}
114
115
116
117
118 == Sub-paragraph ==
119
120 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
121
122 === Sub-sub paragraph ===
123
124 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
125
126 = Paragraph 2 =
127
128 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
129
130 == Sub-paragraph ==
131
132 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
133
134 ~== Sub-paragraph ==
135
136 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.