Зміни в документі Версія 6: Налаштування

Підсумок

• Властивості сторінки (1 змінено, 0 додано, 0 видалено)

Подробиці

Властивості сторінки

Вміст

...	...	@@ -59,6 +59,13 @@
59	59
60	60
61	61
	62	+
	63	+
	64	+
	65	+
	66	+
	67	+
	68	+
62	62	== Параметр {{code language="none"}}clients_tokens{{/code}} ==
63	63
64	64	Тепер слід вказати масив клієнтськіх токенів, які будуть мати доступ до API.
...	...	@@ -210,6 +210,67 @@
210	210	key_for_methods: some_custom_key
211	211	{{/code}}
212	212
	220	+=== (% id="cke_bm_617119S" style="display:none" %) (%%)Параметр {{code language="none"}}async_dsn_info{{/code}} ===
	221	+
	222	+Відповідає за відображення в документації інформації про асинхронний транспорт.
	223	+
	224	+{{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
	225	+ufo_json_rpc:
	226	+ async_dsn_info: true # or false
	227	+{{/code}}
	228	+
	229	+==== **Приклад документації ** ====
	230	+
	231	+{{code language="json" layout="LINENUMBERS" title="GET: /api"}}
	232	+{
	233	+ "envelope": "JSON-RPC-2.0/UFO-RPC-6",
	234	+ "contentType": "application/json",
	235	+ "description": "",
	236	+ "transport": {
	237	+ "sync": {
	238	+ "scheme": "http",
	239	+ "host": "example.com",
	240	+ "path": "/api",
	241	+ "method": "POST"
	242	+ },
	243	+ "async": {
	244	+ "scheme": "amqp",
	245	+ "user": "{user}",
	246	+ "pass": "{pass}",
	247	+ "host": "async_rabbit",
	248	+ "port": 5672,
	249	+ "path": "/%2f/json-rpc"
	250	+ }
	251	+ },
	252	+ "methods": {
	253	+ ...
	254	+ }
	255	+}
	256	+{{/code}}
	257	+
	258	+
	259	+
	260	+{{info}}
	261	+Не переймайтеся щодо безпеки ваших авторизаційних даних. що містяться в DSN.
	262	+
	263	+Документатор побудований таким чином, що перед виводом інформації про DSN він видаляє дані про користувача і його пароль, а також інші секретні дані, як то токени, секретні ключі, тощо.
	264	+
	265	+Шаблон, по якому відбувається захист {{code language="none"}}/([\w\d_]*(?:secret|access|token|key)[_\w]*)=((?:\w|\d)+(?=&?))/{{/code}}.
	266	+
	267	+Приклад:
	268	+
	269	+{{code language="json" layout="LINENUMBERS" title="RPC_TRANSPORT_DSN=https://sqs.eu-west-3.amazonaws.com/123456789012/messages?access_key=AKIAIOSFODNN7EXAMPLE&secret_key=j17M97ffSVoKI0briFoo9a"}}
	270	+{
	271	+ "async": {
	272	+ "scheme": "https",
	273	+ "host": "sqs.eu-west-3.amazonaws.com",
	274	+ "path": "/123456789012/messages",
	275	+ "query": "access_key={access_key}&secret_key={secret_key}"
	276	+ }
	277	+}
	278	+{{/code}}
	279	+{{/info}}
	280	+
213	213	=== Параметр {{code language="none"}}validations{{/code}} ===
214	214
215	215	Відповідає за відображення в документації методів додаткових блоків, що вказують на вимоги до валідації даних.