FM
Сам метод, его путь, атрибуты, сам запрос и ответ на него. Все логично
Size: a a a
2019 December 20
СХ
По логике сначала нужно отправить запрос, а после этого уже получить ответ.
FM
По логике сначала нужно отправить запрос, а после этого уже получить ответ.
Именно. Ответ а потом запрос - это как то нелогично
BN
Fox Mulder
Сам метод, его путь, атрибуты, сам запрос и ответ на него. Все логично
виноват, не уточнил - на фото уже исправленная версия. в оригинале строки с ответом и запросом расположены в обратном порядке
FM
Тогда ваш вариант правильный
S
Baharev Nick
аргументируйте, пожалуйста)
А вас что смущает?
NV
Baharev Nick
Всем привет. Есть вопрос касательно апи - скажите, прав я или нет: в табличке описания метода сначала должен идти запрос, а потом ответ? Пример на фото.
Мне этот порядок кажется логичным. Сначала всё про запрос, потом всё про ответ. Но если читатели уже привыкли к другому порядку, то может и не стоит их теперь запутывать.
BN
Мне этот порядок кажется логичным. Сначала всё про запрос, потом всё про ответ. Но если читатели уже привыкли к другому порядку, то может и не стоит их теперь запутывать.
читатели привыкли не заходить в доку дальше FAQ, им про апи нужно крайне редко)
BN
SystemA
А вас что смущает?
в оригинале последние строки расположены в обратном порядке, на фото исправленная версия
DS
Параметры ответа тоже нужны, по-хорошему
FM
Тогда сделайте так как считаете нужным. Вы. как техпис определяете знания по продукту. Собственно и косвенно обложку этих знаний
NV
Параметры ответа тоже нужны, по-хорошему
+1, или даже схема, если там сложный JSON/XML
СХ
Baharev Nick
я бы с радостью, но именно эта табличка принята за шаблон у нас. предыдущий техпис сделал так, что реквест идет после респонса, вот я и думаю, стоит ли менять))
А почему нельзя поменять шаблон и узаконить его? Тем более никто почти не доходит до описания API
SR
Baharev Nick
Всем привет. Есть вопрос касательно апи - скажите, прав я или нет: в табличке описания метода сначала должен идти запрос, а потом ответ? Пример на фото.
Привет. Вполне нормально как в таблице. Пример: https://idratherbewriting.com/learnapidoc/activities_pdf.html
BN
А почему нельзя поменять шаблон и узаконить его? Тем более никто почти не доходит до описания API
так и поступлю, да) сложность в том, что надо будет во всей доке менять местами две строки. такой пустяк, а времени уйдет уйма
FM
Он был автором 100 рац предложений. Его фото висело на доске почета. И только сам Иван Иванович Козюлькин знал, чем он занимался на самом деле. Иван Иванович занимался фигней
BN
Параметры ответа тоже нужны, по-хорошему
ответ у нас описывается не в таблице, а отдельно
BN
Fox Mulder
Он был автором 100 рац предложений. Его фото висело на доске почета. И только сам Иван Иванович Козюлькин знал, чем он занимался на самом деле. Иван Иванович занимался фигней
вот этой участи очень хочется избежать
MS
Baharev Nick
вот этой участи очень хочется избежать
Доски?)