У меня ещё один вопрос:чтобы грамотно документировать API,нужно:1.БД,общее понимание (таблицы,связи,первичные ключи, foreign ключи,связи).2.знание HTTP, на основе этих знаний придет и понимание REST API.
У меня ещё один вопрос:чтобы грамотно документировать API,нужно:1.БД,общее понимание (таблицы,связи,первичные ключи, foreign ключи,связи).2.знание HTTP, на основе этих знаний придет и понимание REST API.
У меня ещё один вопрос:чтобы грамотно документировать API,нужно:1.БД,общее понимание (таблицы,связи,первичные ключи, foreign ключи,связи).2.знание HTTP, на основе этих знаний придет и понимание REST API.
Уметь читать код и задавать вопросы разрабам. Понимать как разложить архитектуру документа, если нет автогенерации (и не предвидится в обозримом будущем). Самостоятельно отправлять запросы через тот же postman.
Уметь читать код и задавать вопросы разрабам. Понимать как разложить архитектуру документа, если нет автогенерации (и не предвидится в обозримом будущем). Самостоятельно отправлять запросы через тот же postman.
Что значит: разложить архитектуру документа?Есть пример спецификации по конечным точкам от Заказчика.Есть настроенный postman с нужным environment.Запросы отправлять умею,умею анализировать респонзы,понимаю разницу в методах,понимаю параметры запроса и параметры ответа
Что значит: разложить архитектуру документа?Есть пример спецификации по конечным точкам от Заказчика.Есть настроенный postman с нужным environment.Запросы отправлять умею,умею анализировать респонзы,понимаю разницу в методах,понимаю параметры запроса и параметры ответа
Очень часто в документации апи приходится переиспользовать хотя бы описание параметров. Если это делать через «копировать-вставить», то поддержка такого документа превратится в очень сложное занятие.
Очень часто в документации апи приходится переиспользовать хотя бы описание параметров. Если это делать через «копировать-вставить», то поддержка такого документа превратится в очень сложное занятие.
Можно вопрос:есть в документе от Заказчика раздел :общие параметры(page size,page number и т.д).Они всегда будут одинаковые для всех конечных точек?
Можно вопрос:есть в документе от Заказчика раздел :общие параметры(page size,page number и т.д).Они всегда будут одинаковые для всех конечных точек?
Это лучше уточнить у заказчика) бывает, что разные группы методов пишут разные группы разработки и получаются разные названия параметров. Хочется верить, что это не очень частый случай, но лучше уточнить есть ли в компании какие-то договоренности по названию параметров
Есть разработанная техлидом логическая модель.Отношения между сущностями проставлены.Мне как ТП нужно это отдельным требованием описывать?
Лучше это тоже уточнить у заказчика) если считаете важным — описывайте, конечно. Тем более если нет четкого списка что должно быть в конечном документе — вся информация на ваше усмотрение. Но когда сомневаетесь — лучше уточнить у заказчика.