Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/algolia/api-clients-automation
🤖 Monorepo of the Algolia API specs and their auto-generated clients and documentation
https://github.com/algolia/api-clients-automation
algolia api-clients codegen openapi sdk search specs
Last synced: 2 months ago
JSON representation
🤖 Monorepo of the Algolia API specs and their auto-generated clients and documentation
- Host: GitHub
- URL: https://github.com/algolia/api-clients-automation
- Owner: algolia
- License: mit
- Created: 2021-10-20T10:56:09.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T00:16:31.000Z (7 months ago)
- Last Synced: 2024-04-14T06:44:58.602Z (7 months ago)
- Topics: algolia, api-clients, codegen, openapi, sdk, search, specs
- Language: PHP
- Homepage: https://api-clients-automation.netlify.app/
- Size: 93.9 MB
- Stars: 30
- Watchers: 44
- Forks: 9
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# API Clients Automation
The Algolia API clients are generated from [OpenAPI specs](https://swagger.io/specification/), leveraging the open-source [openapi-generator](https://openapi-generator.tech/) tool.
[](./LICENSE.md)
API clients automation documentation •
Algolia documentation
**Migration note from current API clients**
> In 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](https://www.algolia.com/doc/libraries/). You can still browse the documentation of the stable clients on [the Algolia documentation](https://www.algolia.com/doc/).
## 💡 Getting Started with the clients
You can read `getting started` guides and how to use the API clients on [our documentation](https://www.algolia.com/doc/libraries/).
## ✨ Contributing
> Looking to add a new client, or fix a bug? Make sure to take a look at [our contribution guides](https://api-clients-automation.netlify.app/docs/introduction).
### Setup repository tooling
```bash
nvm use && yarn
```
### Setup dev environment
> **Make sure to have Docker installed so you don't have to install the tooling for every API clients.**
```bash
yarn docker:setup
```
[Read more on our documentation](https://api-clients-automation.netlify.app/docs/setup-repository)
### CLI
The CLI allows you to make changes locally and run commands through the docker container.
- [Specs CLI commands](https://api-clients-automation.netlify.app/docs/CLI/specs-commands)
- [Clients CLI commands](https://api-clients-automation.netlify.app/docs/CLI/clients-commands)
- [CTS CLI commands](https://api-clients-automation.netlify.app/docs/CLI/cts-commands)
### Guides and requirements
Read the guides and requirements to:
- [Add a new client](https://api-clients-automation.netlify.app/docs/add-new-api-client)
- [Add a new language](https://api-clients-automation.netlify.app/docs/add-new-api-language)
### Tests
Test the generated clients by running:
- The [`playground`](./playground) (see [documentation](https://api-clients-automation.netlify.app/docs/testing/playground))
- The [`Common Test Suite`](./tests/) (see [documentation](https://api-clients-automation.netlify.app/docs/testing/common-test-suite)).
For full documentation, visit the **[online documentation](https://api-clients-automation.netlify.app/docs/introduction)**.
## ❓ Troubleshooting
Encountering an issue with the API clients? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/) where you will find answers to the most common issues and gotchas with the client.
You can also [open an issue on GitHub](https://github.com/algolia/api-clients-automation/issues/new/choose).
## 📄 License
Algolia API clients automation is an open-sourced software licensed under the [MIT license](LICENSE.md).