Api-blueprint: Общие параметры url для всех запросов

Созданный на 30 сент. 2015 · 8Комментарии · Источник: apiaryio/api-blueprint

Привет,

наш api требует, чтобы клиент добавлял apiKey, подпись и временную метку в качестве строки запроса к каждому запросу

поэтому я должен повторять эту часть запроса в каждом определении ресурса, подобном этому

## Client [/clients/{id}?apiKey={apiKey}&signature={signature}&amp;timestamp={timestamp}]

а затем параметры

+ Parameters
    + apiKey (required, string, `2961654ce6c3d01c79edc98c8d930d4cc663cda4`) 
    + signature (required, string, `213213jjflkjdsfl343k4jjfdsdsf`) 
    + timestamp (required, integer, `1443620910`)

поскольку у нас есть конечные точки, работающие с коллекциями, а затем с одним ресурсом, мне нужно скопировать и вставить это для каждой группы как минимум дважды, а затем изменить шаблоны URL-адресов, которые принимают некоторые дополнительные параметры запроса

когда у вас много групп ресурсов, это становится довольно утомительно, и если вы добавите еще один общий требуемый параметр запроса, вам придется все обновить

Я предлагаю добавить раздел commonParams в начало документа с планом, и эти параметры затем будут применяться ко всем запросам.

Источник

bazo

Самый полезный комментарий

Есть новости по этому поводу?

Если Parameters действуют как Attributes в своей способности выполнять простое наследование от централизованного data-structures.md , кодовая база наших чертежей будет намного более удобной в обслуживании / DRY.

jars 7 нояб. 2017

👍3

Все 8 Комментарий

Привет, @bazo , пока это не поддерживается. У нас есть предложение по этому поводу в

Где вы можете ссылаться и наследовать другие параметры.

# Resource [/resource/{client}{?signature,apiKey,timestamp}]
+ Parameters (Authentication)
    + client: foo

# Data Structures
## Authentication (Parameters)
+ apiKey: 2961654ce6c3d01c79edc98c8d930d4cc663cda4 
+ signature: 213213jjflkjdsfl343k4jjfdsdsf
+ timestamp: 1443620910 (integer)

kylef 1 окт. 2015

Думаю, у него есть хороший вопрос:

поэтому я должен повторять эту часть запроса в каждом определении ресурса, подобном этому

@zdne Что ты думаешь? Можем ли мы что-то сделать с повторением шаблона uri?

pksunkara 1 окт. 2015

У меня действительно есть соблазн снова открыть эту проблему. Я думаю, что эта проблема больше связана с определением общих параметров для более чем одного ресурса, а не с использованием синтаксиса стиля MSON.

@zdne Был бы очень поводу .

pksunkara 2 окт. 2015

Идеально было бы определить их в какой-то специальной схеме аутентификации. Аналогично https://github.com/apiaryio/api-blueprint-rfcs/blob/kylef/authentication-oauth2/draft/authentication-oauth2.md.

kylef 2 окт. 2015

Ничего страшного, если они связаны с параметрами аутентификации. Я говорю о других параметрах, таких как page , per_page т. Д. В основном все, что можно использовать для всех ресурсов.

pksunkara 2 окт. 2015

Будет использовать это тоже.

borekb 4 нояб. 2016

👍3

@kylef ссылка, на которую вы ссылались в своем комментарии от 1 октября 2015 г., больше не работает. Мы будем признательны за советы по удобным способам указать, что каждой конечной точке требуется токен-носитель OAuth 2.