Wie können Sie Continuous Integration mit GraphQL-APIs implementieren?

Kontinuierliche Integration (CI) ist eine Praxis, die Entwicklern hilft, qualitativ hochwertigen Code schneller und zuverlässiger bereitzustellen. Es beinhaltet die Automatisierung des Erstellens, Testens und Bereitstellens von Codeänderungen, wenn sie an ein Versionskontrollsystem übertragen werden. CI kann auch die Zusammenarbeit und die Feedbackschleife zwischen Entwicklern, Testern und Stakeholdern verbessern.

GraphQL ist eine Abfragesprache und ein Laufzeitsystem, mit dem Clients die benötigten Daten von einer API angeben können. GraphQL-APIs können viele Vorteile bieten, wie z. B. schnellere Leistung, bessere Skalierbarkeit und mehr Flexibilität. Sie stellen jedoch auch einige Herausforderungen für CI dar, wie z. B. Schemavalidierung, Mocking und Tests.

In diesem Artikel erfahren Sie, wie Sie CI mit GraphQL-APIs mithilfe einiger gängiger Tools und Techniken implementieren. Sie sehen auch einige Beispiele dafür, wie Sie Ihre CI-Pipeline konfigurieren und Ihre Tests für GraphQL-APIs schreiben.

Find expert answers in this collaborative article

Selected by the community from 6 contributions. Learn more

1 Wählen Sie eine CI-Plattform

Bei der Implementierung von CI mit GraphQL-APIs besteht der erste Schritt darin, eine Plattform auszuwählen, die zu Ihrem Workflow und Technologie-Stack passt. Beliebte Optionen sind GitHub Actions, Jenkins, CircleCI und Travis CI. Jede Plattform sollte Funktionen wie die Integration in Ihr Versionskontrollsystem und Ihren Hosting-Service, Unterstützung für Ihre Programmiersprache und Ihr GraphQL-Framework, parallele und verteilte Auftragsfunktionen, Anpassungs- und Konfigurationsoptionen für Pipeline-Phasen und -Schritte sowie Berichts- und Benachrichtigungstools für Testergebnisse und Codeabdeckung bieten.

Add your perspective

Paul Sweatte
Report contribution
Use a feature comparison site to do an apples-to-apples comparison of CI tools in order to compare them equally. In terms of growth, be sure to look into the pricing tiers and your budget to ensure one does not outstrip the other.

Like

2 Validieren Sie Ihr GraphQL-Schema

Der nächste Schritt zur Implementierung von CI mit GraphQL-APIs besteht darin, Ihr GraphQL-Schema zu validieren. Das Schema ist der Vertrag zwischen Ihrem Client und Ihrem Server, der die Typen, Abfragen, Mutationen und Abonnements definiert, die von Ihrer API unterstützt werden. Die Überprüfung Ihres Schemas kann Ihnen helfen, Fehler, Inkonsistenzen und Breaking Changes zu erkennen, bevor sie sich auf Ihre Clients auswirken.

Es gibt verschiedene Möglichkeiten, Ihr Schema zu validieren, abhängig von Ihrer CI-Plattform und Ihrem GraphQL-Framework. Sie können beispielsweise das Apollo CLI-Tool verwenden, um Ihr Schema mit einem Referenzschema abzugleichen, das in Apollo Studio gespeichert ist, einem Cloud-Dienst, der Schemaverwaltung und -analyse für GraphQL-APIs bereitstellt. Alternativ können Sie das Tool graphql-schema-linter verwenden, um Ihr Schema anhand einer Reihe von Regeln und Best Practices zu überprüfen.

Add your perspective

3 Simulieren Sie Ihren GraphQL-Server

Der dritte Schritt zur Implementierung von CI mit GraphQL-APIs besteht darin, Ihren GraphQL-Server zu simulieren. Wenn Sie Ihren Server simulieren, können Sie Ihren clientseitigen Code von Ihren serverseitigen Abhängigkeiten isolieren und Ihren Testprozess beschleunigen. Wenn Sie Ihren Server verspotten, müssen Sie einen gefälschten oder simulierten Server erstellen, der vordefinierte Daten für Ihre GraphQL-Abfragen und -Mutationen zurückgibt.

Es gibt verschiedene Möglichkeiten, Ihren Server zu verspotten, abhängig von Ihrer CI-Plattform und Ihrem GraphQL-Framework. Sie können z.B. die Apollo Server Testing-Bibliothek verwenden, um einen Mock-Server basierend auf Ihrem Schema und Ihren Resolvern zu erstellen. Alternativ können Sie die graphql-tools-Bibliothek verwenden, um einen Mock-Server basierend auf Ihrem Schema und einigen benutzerdefinierten Funktionen zu erstellen.

Add your perspective

Paul Sweatte
Report contribution
Decide upfront whether or not to mock your environment specific user IDs when testing queries and mutations. This will have a large impact on whether or not you need to test the integrity of the mock data against environment specific constraints or not.

Like

4 Testen Sie Ihre GraphQL-Abfragen und -Mutationen

Der vierte Schritt zur Implementierung von CI mit GraphQL-APIs besteht darin, Ihre GraphQL-Abfragen und -Mutationen zu testen. Durch das Testen Ihrer Abfragen und Mutationen können Sie überprüfen, ob Ihre API die erwarteten Daten zurückgibt und die möglichen Fehler behandelt. Das Testen Ihrer Abfragen und Mutationen bedeutet, Code zu schreiben und auszuführen, der Anfragen an Ihren GraphQL-Server sendet und die Antworten mit den erwarteten Ergebnissen vergleicht.

Es gibt verschiedene Möglichkeiten, Ihre Abfragen und Mutationen zu testen, abhängig von Ihrer CI-Plattform und Ihrem GraphQL-Framework. Sie können z. B. das Jest-Framework und die @apollo/client/testing-Bibliothek zum Schreiben und Ausführen von Tests für Ihre React-Komponenten, die den Apollo-Client verwenden, um Daten von Ihrem GraphQL-Server abzurufen. Alternativ können Sie das Mocha-Framework und die Supertest-Bibliothek verwenden, um Tests für Ihren Node.js Server zu schreiben und auszuführen, der Express und GraphQL verwendet.

Add your perspective

Paul Sweatte
Report contribution
Make sure both the variables and results are validated using a JSON schema. This will ensure that data quality is encapsulated within the tests and that not only is the GraphQL schema validated, but also the payloads being passed back and forth between the client and the server.

Like

5 Testen Sie Ihre GraphQL-Abonnements

Der fünfte Schritt zur Implementierung von CI mit GraphQL-APIs besteht darin, Ihre GraphQL-Abonnements zu testen. Abonnements sind eine Funktion von GraphQL, die es Clients ermöglicht, Echtzeit-Updates vom Server zu erhalten, wenn sich Daten ändern. Durch das Testen Ihrer Abonnements können Sie überprüfen, ob Ihre API die richtigen Benachrichtigungen sendet und die möglichen Fehler behandelt. Das Testen Ihrer Abonnements bedeutet, Code zu schreiben und auszuführen, der eine Verbindung zu Ihrem GraphQL-Server herstellt und auf die Ereignisse lauscht.

Es gibt verschiedene Möglichkeiten, Ihre Abonnements zu testen, abhängig von Ihrer CI-Plattform und Ihrem GraphQL-Framework. Sie können z. B. das Jest-Framework und die @apollo/client/testing-Bibliothek zum Schreiben und Ausführen von Tests für Ihre React-Komponenten, die den Apollo-Client verwenden, um Daten von Ihrem GraphQL-Server zu abonnieren. Alternativ können Sie das Mocha-Framework und die ws-Bibliothek verwenden, um Tests für Ihren Node.js Server zu schreiben und auszuführen, der WebSocket und GraphQL verwendet.

Add your perspective

Paul Sweatte
Report contribution
The subscription implementation is an optional part of the GraphQL specification. If it is not provided, the server does not support subscriptions. If the server does not support subscriptions, they cannot be tested.

Like

6 Überwachen Sie Ihre GraphQL-Leistung

Der sechste und letzte Schritt zur Implementierung von CI mit GraphQL-APIs besteht darin, Ihre GraphQL-Leistung zu überwachen. Die Überwachung Ihrer Leistung kann Ihnen helfen, die Engpässe und Ineffizienzen Ihrer API zu identifizieren und zu optimieren. Die Überwachung Ihrer Leistung bedeutet, Metriken wie Antwortzeit, Fehlerrate, Abfragekomplexität und Abfragetiefe zu sammeln und zu analysieren.

Es gibt verschiedene Möglichkeiten, Ihre Leistung zu überwachen, abhängig von Ihrer CI-Plattform und Ihrem GraphQL-Framework. Sie können beispielsweise den Apollo Studio-Dienst verwenden, um Ihre Leistungsmetriken für Ihre GraphQL-API zu verfolgen und zu visualisieren. Alternativ können Sie die Bibliotheken graphql-query-complexity und graphql-depth-limit verwenden, um die Komplexität und Tiefe Ihrer GraphQL-Abfragen zu begrenzen und zu messen.

Add your perspective

Mudassar Ahamer Hakim

Tech Leader & People Manager | Driving Engineering Excellence & Team Growth | Delivering Impactful Solutions
Report contribution
in addition to the mentioned tools, there are other 2 effective performance monitoring tools and services: New Relic: New Relic is a comprehensive application performance monitoring tool that can be used for monitoring GraphQL APIs. It provides real-time insights into response times, error rates, and database queries, helping you pinpoint performance bottlenecks. Prometheus and Grafana: These open-source tools, when used together, can provide powerful monitoring and alerting capabilities. Prometheus collects metrics, while Grafana offers visualization and alerting features. You can set up custom queries to monitor specific aspects of your GraphQL API.

Like

7 Hier ist, was Sie sonst noch beachten sollten

Dies ist ein Ort, an dem Sie Beispiele, Geschichten oder Erkenntnisse teilen können, die in keinen der vorherigen Abschnitte passen. Was möchten Sie noch hinzufügen?

Add your perspective

Paul Sweatte
Report contribution
Deprecation directives or arguments within a GraphQL server implementation should be tested as part of integration with the GraphQL specification.

Like

Wie können Sie Continuous Integration mit GraphQL-APIs implementieren?

1

2

3

4

5

6

7

1 Wählen Sie eine CI-Plattform

2 Validieren Sie Ihr GraphQL-Schema

3 Simulieren Sie Ihren GraphQL-Server

4 Testen Sie Ihre GraphQL-Abfragen und -Mutationen

5 Testen Sie Ihre GraphQL-Abonnements

6 Überwachen Sie Ihre GraphQL-Leistung

7 Hier ist, was Sie sonst noch beachten sollten

Application Development

Rate this article

Thanks for your feedback

More articles on Application Development

More relevant reading