API

Тема проектирования интерфейсов для взаимодействия двух систем, кажется, еще долго не сможет себя исчерпать. Здесь собраны статьи и материалы, касающиеся этого вопроса.

22.10.2024

Шаблон описания документации REST API и пример заполнения

Это пример заполненного документа для API REST. Здесь о том, что важно написать и в каком виде удобней отразить. Пустой шаблон для заполнения предлагаем для скачивания.

27.08.2024

Шаблон документации API для JSON-RPC и образец заполнения

Если перед вами стоит задача задокументировать API протокола JSON-RPC, воспользуйтесь этим примером как отправной точкой.

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

Гарантия доставки сообщения "Exactly once"

09.04.2024

Обеспечение согласованности данных в распределенных системах. Гарантии доставки сообщений

Легко делать покупки в онлайн магазине. Зашел — выбрал — купил — ждешь — получаешь товар и радуешься приобретению. Легко покупателю, но не проектировщику/разработчику этого магазина. В “жизненном цикле” заказа важно не потерять товар и деньги. Еще важнее – не потерять данные. Что если деньги со счета клиента спишутся, а на счет продавца не придут? […]

11.12.2022

Из чего состоит Swagger (OpenAPI) документ и как с ним работать

Бизнес и системные аналитики часто работают с документацией, описывающей API различных сервисов. Если их (сервисов) в компании больше двух и они обмениваются между собой данными в архитектурном стиле REST, есть смысл изучить фреймворк Swagger, также известный как OpenAPI. Основные преимущества ведения REST API документации в Swagger: Вся эта информация описывается в одном документе, но отображается […]