Версія 8.2 додана 2024/05/08 17:46 автором 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 ['all' => true],
52 // ...
53 ];
54
55 {{/code}}
56
57 = =
58
59 = =
60
61 = Крок 3: Додавання параметрів =
62
63 {{warning}}
64 **Якщо ви виконали «Крок 0», це налаштовано автоматично і ви можете пропустити цей крок.**
65 {{/warning}}
66
67 В разі ручного налаштування бандлу, додайте (% id="cke_bm_4952S" style="display:none" %) (%%)до папки {{code language="none"}}config/packages{{/code}} файл {{code language="none"}}ufo_json_rpc.yaml{{/code}} із таким вмістом:
68
69 {{code language="yaml"}}
70 # config/packages/ufo_json_rpc.yaml
71 ufo_json_rpc:
72 security:
73 protected_methods: ['GET', 'POST'] # protection of GET and POST requests
74 token_key_in_header: 'Ufo-RPC-Token' # Name of the key in the header
75 clients_tokens:
76 - 'ClientTokenExample' # hardcoded token example. Importantly!!! Replace or delete it!
77 - '%env(resolve:UFO_API_TOKEN)%' # token example from .env.local
78
79 # Configuration for API documentation
80 docs:
81 # Optional response details
82 response:
83 key_for_methods: services # Key used to map services for API methods
84 # Information about validations
85 validations:
86 json_schema: false # Indicates if JSON-schema is used for method validation
87 symfony_asserts: false # Indicates if an array of Symfony validation constraints is used
88
89 {{/code}}
90
91 (% class="wikigeneratedid" %)
92 Детальний огляд параметрів налаштування доступний в розділі [[Налаштування бандлу>>doc:docs.JsonRpcBundle.config]]
93
94 = Крок 4: Реєстрація маршрутів =
95
96 {{warning}}
97 **Якщо ви виконали «Крок 0», це налаштовано автоматично і ви можете пропустити цей крок.**
98 {{/warning}}
99
100 (% 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}} із таким вмістом:
101
102 {{code language="yaml"}}
103 # config/routes/ufo_json_rpc.yaml
104 ufo_json_rpc:
105 resource: ../../vendor/ufo-tech/json-rpc-bundle/config/router.yaml
106 prefix: /api
107 trailing_slash_on_root: false
108 {{/code}}
109
110
111
112
113 == Sub-paragraph ==
114
115 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.
116
117 === Sub-sub paragraph ===
118
119 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.
120
121 = Paragraph 2 =
122
123 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.
124
125 == Sub-paragraph ==
126
127 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.
128
129 ~== Sub-paragraph ==
130
131 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.