api clients automation

Automatisierung von API-Clients

Die Algolia-API-Clients werden aus OpenAPI-Spezifikationen generiert und nutzen das Open-Source-Tool openapi-generator.

Dokumentation zur API-Client-Automatisierung • Algolia-Dokumentation

Migrationshinweis von aktuellen API-Clients

Im Juli 2022 haben wir eine Alpha-Version mit generierten API-Clients für die Sprachen JavaScript, Java und PHP veröffentlicht. Wenn Sie die neueste stabile Version dieser Clients verwenden und ein Upgrade durchführen möchten, lesen Sie den Migrationsleitfaden. Sie können weiterhin die Dokumentation der stabilen Clients in der Algolia-Dokumentation durchsuchen.

Erste Schritte mit den Kunden

In unserer Dokumentation finden Sie Anleitungen getting started und zur Verwendung der API-Clients.

Mitwirken

Möchten Sie einen neuen Client hinzufügen oder einen Fehler beheben? Schauen Sie sich unbedingt unsere Beitragsleitfäden an.

Richten Sie Repository-Tools ein

nvm use && yarn

Richten Sie die Entwicklungsumgebung ein

Stellen Sie sicher, dass Docker installiert ist, damit Sie die Tools nicht für jeden API-Client installieren müssen.

yarn docker:setup

Lesen Sie mehr in unserer Dokumentation

CLI

Mit der CLI können Sie lokal Änderungen vornehmen und Befehle über den Docker-Container ausführen.

• Gibt CLI-Befehle an
• Client-CLI-Befehle
• CTS-CLI-Befehle

Richtlinien und Anforderungen

Lesen Sie die Leitfäden und Anforderungen, um:

• Fügen Sie einen neuen Kunden hinzu
• Fügen Sie eine neue Sprache hinzu

Tests

Testen Sie die generierten Clients, indem Sie Folgendes ausführen:

• Der playground (siehe Dokumentation)
• Die Common Test Suite (siehe Dokumentation).

Die vollständige Dokumentation finden Sie in der Online-Dokumentation .

❓ Fehlerbehebung

Ist ein Problem mit den API-Clients aufgetreten? Bevor Sie sich an den Support wenden, empfehlen wir Ihnen, unsere FAQ zu lesen, wo Sie Antworten auf die häufigsten Probleme und Fallstricke des Kunden finden.

Sie können ein Problem auch auf GitHub öffnen.

? Lizenz

Die Automatisierung von Algolia API-Clients ist eine Open-Source-Software, die unter der MIT-Lizenz lizenziert ist.