Перейти к основному содержимому

API

Netuno имеет собственный фреймворк для создания REST API в стиле low-code с поддержкой JWT (JSON Web Token) и OpenAPI 3.0.

Весь фреймворк для разработки веб-сервисов в Netuno очень универсален и позволяет выполнять разработку любого типа.

Фреймворк уже включает множество возможностей для low-code разработки, позволяя сэкономить множество строк кода при реализации наиболее распространённых задач, таких как отправка писем, использование других REST API, интеграция с другими базами данных, генерация PDF- и Excel-файлов, отправка SMS, работа с данными базы данных и многие другие.

А когда в фреймворке Netuno нет готовых решений, можно легко интегрировать существующие библиотеки Java, Kotlin или даже JavaScript для разработки индивидуальных ресурсов и их интеграции с фреймворком Netuno.

JWT - JSON Web Token​

JWT.io — это спецификация стандарта передачи данных контекста сессии клиенту через объект JSON.

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

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

В Netuno интегрирована поддержка JWT; она проста и удобна в использовании, а также работает в связке с пользователями и встроенной аутентификацией Netuno.

OpenAPI 3.0​

После успеха Swagger v1 и v2, которые уже давно стали стандартом для разработки описаний веб-сервисов и генерации клиентского кода.

Так Swagger сделал своё описание открытым, и оно стало OpenAPI 3.

Он по-прежнему остаётся основой для определения стандарта документирования API и генерации клиентов для использования API.

Netuno уже включает полную интеграцию с OpenAPI 3.0 и использует описание OpenAPI вместе с валидацией JSON Schema.

Это означает, что Netuno также позволяет валидировать входные и выходные данные веб-сервисов, используя валидацию схемы полученного и возвращаемого JSON следующим образом:

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

Таким образом, Netuno не только избавляет от создания множества if в коде для валидации полученных данных, но и обеспечивает проверку результата, который генерирует веб-сервис, выполняя юнит-тест.

Кроме того, структуру OpenAPI, сгенерированную Netuno, можно использовать с редактором Swagger, чтобы создавать интерфейс для тестирования, документацию и код клиентов API на других технологиях.

Основы​

Netuno также поддерживает создание веб-сервисов и аутентификацию без лишних сложностей, то есть использовать JWT или OpenAPI не обязательно, хотя это стандартная рекомендация.

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

Netuno позволяет выполнять HTTP-аутентификацию.