Документация: описываем методы API в зависимости от способа интеграции в приложении

• Видео начинается с обсуждения того, что такое API и как его описывать в документации.  

• API расшифровывается как Application Programming Interface и используется для взаимодействия между системами.  

• В документации важно указать технологию, на которой основан API, и пример запроса.  

• Также нужно дать краткое описание того, для чего нужен метод, и ссылку на подробное описание.  

• В видео приводятся примеры документации для различных API, включая сервис отслеживания действий пользователя в системе, книжный магазин и сервис размещения заказа для доставки пиццы.  

• В каждом примере описывается структура запроса и ответа, а также параметры и их типы.  

• В видео также обсуждается спецификация OpenAPI, которая позволяет управлять версионностью документации и отслеживать изменения в системе контроля версий.  

• Пример использования спецификации OpenAPI для описания API интернет-магазина.  

• Рекомендуется хранить документацию в единой базе знаний, независимо от используемого инструмента.  

• Можно использовать постман для документации и конфлюенс для описания моделей, блоков кода и примеров запросов.  

• План хмели удобен для рисования диаграмм.  

• Опынапе может генерировать документацию на основе схемы, но ее нужно описать.  

• Граф кель требует аккуратного отношения к запросам, чтобы не положить сервер или бэк.  

• Аналитик должен предупредить о возможном большом массиве данных и предложить решения.  

• Архитектор должен согласовывать документацию с аналитиком.  

• Можно задать ограничения в параметрах запроса для получения только нужных данных.