себя узнать следующее: вы когда описываете запросы,как выходите из ситуации когда для части данных в запросе используются другие запросы, т.е зависимые, при документировании говорите, что перед использование данного запроса, необходимо выполнить вот эти запросы, а если последние еще от части зависят?
это называется flow или сценарий, описывается цепочка вызовов api для достижения пользовательской цели
Спасибо, буду знать
дополнительные запросы, а их может быть несколько, описываются в алгоритме работы основного метода дополнительные методы описываются с параметрами, примерами запроса и ответа, и другими данными, если они есть
Ясно, спасибо. Подскажите, а в описание API группируются по сценарием: к примеру существует сценарий для получения чего либо или для достижения чего либо, тогда сценарий включает в себя запрос 1, запрос 4 и запрос 5, т.е структура описания не запрос 1, запрос 2 и т.д а именно по сценариям, при этом часть запросов вынести как универсальные, так как они используются в разных сценариях или обычно как у меня на одной работе было все в кучу навалено, какой из методов используется в сценарии было непонятно, так как самих сценариев не было, зато был универсальный запрос, в ответ на который приходило практически все
Обсуждают сегодня