GoMVP

API

Справочник2 min read

Что это

API (произносится «эй-пи-ай») — это способ, которым одна программа обращается к другой. Представьте официанта: вы не заходите на кухню сами, а говорите официанту, что хотите, — и получаете блюдо. API — такой официант между программами: он описывает, какие «заказы» можно сделать, что для этого нужно передать и что придёт в ответ.

Артефакт API в GoMVP — это спецификация: список таких «заказов» (их называют эндпоинтами) с описанием, что каждый принимает и возвращает.

Зачем основателю

Сам основатель API обычно не читает — это документ для разработчиков. Но он важен, потому что:

  • по нему разработчик понимает, как устроен обмен данными, без долгих объяснений;
  • он показывает, что продукт может интегрироваться с другими сервисами (оплата, доставка, CRM);
  • он экономит время и деньги на этапе разработки — меньше недопониманий.

Что внутри

  • Эндпоинты — список доступных операций, например «получить список товаров» или «создать заказ».
  • Что передать — какие данные нужны для каждой операции.
  • Что вернётся — какой ответ придёт в результате.
  • Методы — тип операции: получить данные, создать, изменить, удалить.

Не нужно понимать все детали — достаточно знать, что этот артефакт даёт разработчику готовую инструкцию по обмену данными.

Как создать в GoMVP

  1. Полезно сначала иметь Архитектуру и Базу данных — из них нейросеть понимает, какие операции нужны.
  2. Переключитесь в режим Артефакт и попросите «сделай спецификацию API».
  3. Уточняйте нужные операции через чат — см. Правки через чат.

Артефакт API доступен на тарифе Pro. Условия — на странице тарифов; обзор — в справочнике Тарифы и ракеты.

API