23. November 2022
Drupal JSON-API Params (DJAP)
Dieser Beitrag richtet sich an JavaScript-Entwickler, die an einer entkoppelten Website arbeiten, die die JSON-API des Drupal-CMS nutzt. Ich möchte zeigen, wie wir mit „drupal-jsonapi-params“ (kurz DJAP, eine JavaScript-Bibliothek) die Lesbarkeit des Codes verbessern und die Entwicklererfahrung optimieren können.
DISCLAIMER Ich bin der Betreuer von drupal-jsonapi-params (kurz DJAP). DJAP steht für „drupal-jsonapi-params“ – ein Begriff, der von Stuart Clark alias Deciphered, dem Schöpfer des Druxtjs-Projekts (Nuxt + Drupal), geprägt wurde. Lassen Sie uns nun darüber sprechen, wie DJAP JavaScript-Entwicklern helfen kann, die an einer entkoppelten Website arbeiten und dabei die JSON-API des Drupal-CMS nutzen.
Hintergrund
Beim Abrufen von Informationen aus einem Drupal-Backend müssen wir häufig Filter verwenden. Die Dokumentationsseite auf Drupal.org bietet eine hervorragende Anleitung dazu, wie dies umgesetzt werden kann.
Beispiel A: Um Artikel abzurufen, die als „Promoted“ oder „Sticky“ gekennzeichnet und vom Administrator erstellt wurden, würden Sie einen Abfrageparameter wie folgt formulieren:
Zur besseren Verständlichkeit nachfolgend eine aufgeschlüsselte Abfrage:
Angenommen, wir verwenden Axios in unserem Projekt, dann würde ein Abruf in etwa wie folgt aussehen:
Problem
Wer nach einem Problem sucht, der wird auch eines finden. Ich bin in ein Projekt eingestiegen, in dem sich unzählige ähnliche Abfragen über den gesamten Code verstreut befanden.
It was difficult for me to understand the intent of the Developer from the query
~ Developer who takes over the project (or me in the future)
Als ich einen Fehler in einer solchen Abfrage beheben wollte, fiel es mir leichter, das Ganze neu zu schreiben, anstatt den Fehler zu finden.
It’s a pain to comprehend what is going on in the merge request I’ve to review. All I see is a fetch request and a lot of letters.
~ Developer who reviews the code
Bei Factorial wenden wir bei der Genehmigung von Merge-Requests das Vier-Augen-Prinzip an. Das Vier-Augen-Prinzip besagt, dass eine Maßnahme erst dann durchgeführt werden darf, wenn sie von zwei Personen genehmigt wurde. Das Vier-Augen-Prinzip wird manchmal auch als Zwei-Mann-Regel oder Zwei-Personen-Regel bezeichnet.
Allerdings sind die Änderungen an den Abfrageparametern in einem Merge-Request schwer zu entschlüsseln.
Adding comments to explain what is going on, helps, although I wish I could be more granular.
~ Developer who writes the code
Du kannst zu solchen Abfragen ausführliche Kommentare hinzufügen, um dir selbst in Zukunft oder einem anderen Entwickler zu helfen. Bitte tue dies.
Lösung
Verwende eine Bibliothek, um die Abfrage zu generieren. Die JSON-API ist keine Drupal-spezifische API. Es stehen zahlreiche Bibliotheken zur Erstellung der Filterabfrage zur Verfügung. Je nach Ihren Vorlieben findest du hier möglicherweise die passende Client-Implementierung.
Wir haben uns für die Bibliothek „drupal-jsonapi-params“ entschieden.
Unser Beispiel A unter Verwendung von „drupal-jsonapi-params“ (kurz DJAP) würde also
Wir können auch detaillierte Kommentare einfügen, um die Lesbarkeit zu verbessern:
Wie Sie sehen können, löst die Bibliothek Probleme hinsichtlich der Lesbarkeit des Codes und verbessert die Entwicklererfahrung erheblich.
Weitere Informationen zu den verfügbaren Methoden finden Sie in der Dokumentation auf der Projektseite.
Abschließende Worte
Drupal JSON-API Params ist ein Open-Source-Projekt. Wenn Ihnen dieses Open-Source-Projekt gefällt, helfen Sie bitte mit, es bekannter zu machen, indem Sie es mit anderen teilen. Wenn Sie das Projekt nutzen und es weiterempfehlen möchten, denken Sie bitte daran, es auf GitHub und anderen Plattformen wie Drupal.org mit einem Stern zu markieren.



