В данной статье мы покажем как работать с API на нашей no-code платформе уровня pro, AppMaster.io. Но, для начала, напомним немного базовой информации про API.
Вводная информация
API означает Application Programming Interface, программный интерфейс приложения. Это способы, с помощью которых клиент и сервер могут взаимодействовать друг с другом. Клиент и сервер отправляют запросы и ответы, а API выступает посредником между ними.
Важно, чтобы взаимодействие сервера и клиента было легким, понятным и удобным. Это упрощает задачу как разработчиков (не нужно заново изобретать новый сервис), так и пользователей (сервис проще освоить, если он работает по знакомому принципу). Существует несколько видов API:
- Web service APIs, XML-RPC, and JSON-RPC, SOAP;
- WebSockets APIs;
- Library-based APIs, Java Script;
- Class-based APIs, C# API, Java.
На no-code платформе AppMaster.io используется стиль REST API.
REST или целиком Representational State Transfer — архитектурный стиль взаимодействия (обмена информацией) между клиентом и сервером. Сервисы в REST API взаимодействуют по протоколу HTTP.
Стиль REST обладает определенными преимуществами. Главное преимущество REST — большая гибкость. REST состоит из простых рекомендаций, давая возможность разработчикам реализовывать требования в своем формате. REST имеет высокую производительность, что очень важно, например, для быстрой загрузки на мобильных устройствах. Именно поэтому все крупные компании такие, как Twitter и Google, уже давно внедрили REST API для своих продуктов. Более детально про работу и главные преимущества REST API вы можете прочитать в нашей статье.
Структура любого запроса включает в себя пять основных компонентов: HTTP метод, эндпоинты, заголовки и тело, параметры запроса.
В REST API используются 4 основных HTTP-метода для работы с ресурсом (информацией) и каждый из них описывает, что должно быть сделано с ресурсом:
- POST — создание ресурса;
- GET — получение ресурса;
- PUT — обновление ресурса;
- DELETE — удаление ресурса.
Ресурс — это любой вид информации (документ, изображение, видео, текст и так далее). На no-code платформе AppMaster.io эта информация доставляется клиенту в нескольких форматах, в том числе, и в самом распротраненнеом — JSON.
Эндпоинт содержит URI — Uniform Resource Identifier (унифицированный идентификатор ресурса), который указывает, где и как найти ресурс в Интернете и включает в себя URL (URL или Uniform Resource Location является полноценным веб-адресом).
В заголовках передается информация как к клиенту, так и к серверу. Главным образом, заголовки предоставляют аутентификационные данные: API ключ, название или IP адрес компьютера, на котором установлен сервер, а также информацию о формате ответа.
Тело необходимо для передачи серверу дополнительной информации: данные тела запроса — это данные, которые вы, например, хотите добавить или заменить.
Документация по API для вашего приложения на нашей платформе создается автоматически и сохраняется в формате OpenAPI (Swagger) в его серверной части.
Вам не нужно специально разбираться, чтобы освоить создание API на AppMaster.io — вы поймете основные принципы, изучив инструменты платформы. Кроме того, основную часть API создает сам AppMaster.io — большинство настроек делается по умолчанию или при подключении модулей. Например, наш модуль предоставляет инструменты для интеграции с API для почтовых рассылок.
Вам потребуется вручную ввести крошечные изменения в некоторые настройки API при интеграции (подключении) вашего приложения к другим приложениям или внешним ресурсам. Далее мы рассмотрим, как это можно сделать.
Создание API на no-code платформе AppMaster.io
Итак, настройки API вы можете найти в нескольких местах на нашей платформе.
Как создать API Эндпоинт на no-code платформе AppMaster.io
Зайдите в ваш аккаунт, в существующий проект.
Зайдите в Data Model Designer. В нем вы увидите модели с данными, которые хотите обработать с помощью API Эндпоинтов. В каждом проекте на старте всегда по умолчанию есть одна модель — User (Пользователь). Если вы находитесь в новом проекте и у вас еще нет своих моделей, создайте их.
Назначьте связи между вашими моделями и сохраните проект.
Зайдите в раздел Эндпоинты в левом меню экрана.
Здесь вы увидите список всех ваших Эндпоинтов и доступных для них методов REST API, подключенных к каждой модели на поле проекта. Вы сможете удалить ненужные методы и изменить их настройки (значок Шестеренки и значок Корзины).
Если в списке нет подходящего Эндпоинта, вы можете создать новый, нажав на кнопку New Endpoint и выбрав подходящий тип. Откроется модальное окно с настройками Эндпоинта.
Как создать внешний API на no-code платформе AppMaster.io
Зайдите в раздел Business Logic в левом меню.
Здесь вы можете создать внешний API запрос во вкладке External API Request (данная опция находится на стадии бета-тестирования).
Кроме того, как мы и упоминали выше, вся документация формируется автоматически и сохраняется в формате OpenAPI (Swagger) в серверной части вашего приложения.
Но Swagger — это не только документация, а, также, возможность протестировать все Эндпойнты прямо на месте, без использования каких-либо сторонних приложений (например, можно обойтись без Postman).
Итоги
Как видите, создавать и менять настройки API с помощью no-code совсем просто и занимает минимум времени. Если у Вас еще нет аккаунта на AppMaster.io — присоединяйтесь к нам и подключайте пробную версию.
