JavaScript API: Как сгенерировать код из схемы OpenAPI

В данной статье расскажем о генерации и использовании JavaScript кода для подключения к сервису RUVDS. JavaScript долгие годы занимает первое место по популярности на Github. Использование JavaScript API (Application Programming Interface) имеет множество преимуществ, особенно для веб-разработчиков. Вот некоторые из них:

• Интерактивность и динамика веб-страниц: JavaScript позволяет добавлять интерактивные элементы на веб-страницы, такие как анимации, обработка событий (например, клики и ввод данных), динамическое обновление контента без перезагрузки страницы.

• Доступ к системным возможностям: С помощью JavaScript можно получить доступ к различным системным ресурсам и функциональностям, таким как геолокация, доступ к камере и микрофону, сенсоры устройства, файловая система и другие.

• Работа с внешними данными: JavaScript API позволяет легко взаимодействовать с внешними сервисами и получать данные через AJAX-запросы, fetch API, WebSockets и другие механизмы, что делает возможным создание сложных веб-приложений.

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

• Расширяемость: Существует множество сторонних библиотек и фреймворков, которые предоставляют дополнительные API для упрощения разработки и добавления функциональности, такой как работа с графикой (например, Canvas API, WebGL), создание пользовательских интерфейсов (например, React, Vue), и многие другие.

• Совместимость с другими технологиями: JavaScript легко интегрируется с HTML и CSS, что позволяет создавать богатые и интерактивные веб-приложения. Также JavaScript может взаимодействовать с серверной частью через API, что делает возможным создание полнофункциональных веб-приложений.

• Поддержка со стороны сообщества и развитие стандарта: JavaScript и его API постоянно развиваются благодаря активному сообществу разработчиков и поддержке крупных компаний, что гарантирует регулярные обновления и улучшения в функциональности.

Генерация кода JavaScript API

• Для начала работы необходимо установить и настроить OpenAPI Generator. Установка и настройка подробно рассмотрены в статье OpenAPI Generator: как установить и настроить.

• Загрузим OpenAPI схему RUVDS API со страницы https://ruvds.com/api-docs/. В результате загрузки у нас появится файл ruvds-api-v2.yaml.

• Перейдем в директорию с файлом ruvds-api-v2.yaml и запустим генерацию JavaScript кода:

npx @openapitools/openapi-generator-cli generate -i ruvds-api-v2.yaml -g javascript -o ruvds-api-javascript

Параметр -o ruvds-api-javascript задаёт название директории в которую будет сохранён сгенерированный код.

• Переходим в директорию ruvds-api-javascript и запускаем сборку пакета:

npm install

• Создадим глобальную ссылку на пакет, который мы только что собрали. Подробная информация есть в документации NPM: https://docs.npmjs.com/cli/link.

npm link

Использование сгенерированного кода на примере получения баланса

• На странице https://ruvds.com/my/settings/api получим токен доступа к API.

• Создадим файл balance.js со следующим кодом:

const RuvdsApi = require('ruvds_api');

const RUVDS_TOKEN = process.env.RUVDS_TOKEN;

let defaultClient = RuvdsApi.ApiClient.instance;
let bearer_auth = defaultClient.authentications['bearer_auth'];
bearer_auth.accessToken = RUVDS_TOKEN;

let balanceApi = new RuvdsApi.BalanceApi();
let opts = {};
balanceApi.balanceGet(opts, (error, data, response) => {
    if (error) {
        throw new Error(error);
    }
    console.log(`Balance: ${data.amount}`);
});

• Возможно, потребуется добавить ссылку на директорию со сгенерированным кодом:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

• Добавим токен доступа к RUVDS API в переменную окружения Powershell и запустим наш JS файл:

$env:RUVDS_TOKEN='Token from https://ruvds.com/my/settings/api'
node .\balance.js