The Algolia API clients are generated from OpenAPI specs, leveraging the open-source openapi-generator tool.
API clients automation documentation • Algolia documentation
Migration note from current API clients
💡 Getting Started with the clientsIn July 2022, we released an alpha version generated API clients for the JavaScript, Java and PHP languages. If you are using the latest stable of those clients and looking to upgrade, read the migration guide. You can still browse the documentation of the stable clients on the Algolia documentation.
You can read getting started
guides and how to use the API clients on our documentation.
Setup repository toolingLooking to add a new client, or fix a bug? Make sure to take a look at our contribution guides.
nvm use && yarnSetup dev environment
Make sure to have Docker installed so you don't have to install the tooling for every API clients.
yarn docker:setup
Read more on our documentation
CLIThe CLI allows you to make changes locally and run commands through the docker container.
Guides and requirementsRead the guides and requirements to:
TestsTest the generated clients by running:
playground
(see documentation)Common Test Suite
(see documentation).For full documentation, visit the online documentation.
❓ TroubleshootingEncountering an issue with the API clients? Before reaching out to support, we recommend heading to our FAQ where you will find answers to the most common issues and gotchas with the client.
You can also open an issue on GitHub.
📄 LicenseAlgolia API clients automation is an open-sourced software licensed under the MIT license.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4