api clients automation

Автоматизация API-клиентов

Клиенты Algolia API генерируются на основе спецификаций OpenAPI с использованием инструмента openapi-generator с открытым исходным кодом.

Документация по автоматизации клиентов API • Документация Algolia

Примечание о переходе с текущих клиентов API

В июле 2022 года мы выпустили альфа-версию API-клиентов для языков JavaScript, Java и PHP. Если вы используете последнюю стабильную версию этих клиентов и хотите выполнить обновление, прочтите руководство по миграции. Вы по-прежнему можете просмотреть документацию стабильных клиентов в документации Algolia.

Начало работы с клиентами

Вы можете прочитать руководства getting started и способы использования клиентов API в нашей документации.

Содействие

Хотите добавить нового клиента или исправить ошибку? Обязательно ознакомьтесь с нашими руководствами по вкладам.

Настройка инструментов репозитория

nvm use && yarn

Настройка среды разработки

Обязательно установите Docker, чтобы вам не приходилось устанавливать инструменты для каждого клиента API.

yarn docker:setup

Подробнее читайте в нашей документации

интерфейс командной строки

CLI позволяет вносить изменения локально и запускать команды через Docker-контейнер.

• Спецификации команд CLI
• Клиентские команды CLI
• Команды CTS CLI

Руководства и требования

Прочтите руководства и требования, чтобы:

• Добавить нового клиента
• Добавить новый язык

Тесты

Протестируйте сгенерированные клиенты, выполнив:

• playground (см. документацию)
• Common Test Suite (см. документацию).

Полную документацию можно найти в онлайн-документации .

❓ Устранение неполадок

Возникли проблемы с клиентами API? Прежде чем обращаться в службу поддержки, мы рекомендуем зайти в раздел часто задаваемых вопросов, где вы найдете ответы на наиболее распространенные проблемы и затруднения с клиентом.

Вы также можете открыть проблему на GitHub.

? Лицензия

Автоматизация клиентов API Algolia — это программное обеспечение с открытым исходным кодом, лицензированное по лицензии MIT.