Синергия Онлайн-школа
предметная библиотека2 мин чтения

Что такое API в программировании на простом примере

Редакция Школьного Университета «Синергия»

Редакция онлайн-школы для 5–11 классов

API — набор правил, по которым одна программа использует возможности другой. Например, приложение с расписанием запрашивает список уроков на понедельник. Сервис получает дату, ищет записи и возвращает их в заранее описанном виде. Приложению достаточно знать, как задать вопрос и как прочитать ответ. Ему не нужно знать, как сервис хранит расписание внутри.

Как выглядит обмен

Представим учебный сервис с адресом /lessons. Запрос GET /lessons?day=monday сообщает, что нужны уроки за понедельник. В ответе могут прийти названия предметов и время. Если программа запрашивает вторник, меняется значение параметра day. Список полей ответа остаётся тем же, и приложение может вывести оба результата одним способом.

Зачем читать документацию

В документации перечислены допустимые операции, параметры и возможные результаты. Например, можно выяснить, понимает ли сервис слово monday, требует ли учётную запись и что означает пустой список. При пустом списке на экране уместно написать «На этот день уроков нет». При сбое соединения такая фраза введёт в заблуждение: расписание ещё не получено.

Как потренироваться без подключения к серверу

На бумаге придумайте сервис школьной библиотеки с двумя запросами: найти книги по автору и проверить, есть ли определённая книга. Для каждого напишите, какие данные нужно передать, что вернётся при успехе и какой ответ получит программа, если книги нет. Поменяйтесь описаниями с другом и попросите его составить правильные запросы. Если он постоянно уточняет одно поле, это место стоит описать точнее.

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

читайте также

предметная библиотека

Режим дня школьника с первой и второй сменой

Два примера расписания, способ расставить кружки и проверка, помещается ли домашняя работа в обычный день.

предметная библиотека

Как вернуться к учёбе после каникул за пять дней

План на первые учебные дни и способ различить усталость, забытые темы и проблемы с расписанием.

предметная библиотека

Как подготовиться к контрольной по математике и русскому

Два плана тренировки, примеры самопроверки и способ понять, какие ошибки разбирать в первую очередь.

← все материалы блога