Vereinfachen Sie Ihre REST-API-Antworten mit Milogo für Gin-Gonic

Gin-Gonic Middleware, die Feldauswahlmuster implementiert

In meinem Unternehmen verwenden wir Go, um interne Tools zu erstellen. Kürzlich habe ich mit gin-gonic in einer REST-API gearbeitet, was die Anzeige vieler Daten über viele Endpunkte hinweg erforderte.

Eine Funktion, die in dieser Art von Szenario unbedingt vorhanden sein muss, ist Paginierung, aber ein oft übersehenes Muster ist Teilantwort (auch Feldauswahl genannt). Das ist auch eine sehr schöne Ergänzung, um die Datenmenge in den Antworten Ihres Webservers herauszufiltern.

Was ist Feldauswahl?

Lassen Sie uns zunächst klarstellen, was ich mit einer Feldauswahl meine. Stellen Sie sich vor, Sie haben den folgenden Endpunkt:

// > GET /api/products
[
  {
    "id": 1,
    "createdAt": "2024-18-11",
    "updatedAt": "2024-18-11",
    "code": "1",
    "price": {
      "amount": 100,
      "currency": "EUR"
    },
    "manufacturedBy": "myshop",
    "stock": 552,
    ...
  },
  ...
]

Mithilfe von Teilantworten können Kunden die Ausgabe mit einem Feldabfrageparameter filtern, z. B.

// > GET /api/products?fields=code,price
[
  {
    "code": "1",
    "price": {
      "amount": 100,
      "currency": "EUR"
    }
  },
  ...
]

Nur die im Abfrageparameter deklarierten Felder werden zurückgegeben. Reduzierung der Nutzlastgröße und Einsparung von Bandbreite.

Wir stellen vor: Milogo

Ich konnte für dieses Muster keine verfügbare Implementierung finden, also beschloss ich, es selbst zu erstellen, und so wurde Milogo geboren.
Milogo ist eine Gin-Middleware, die API-Antworten verarbeitet, im Abfrageparameter „Felder“ angegebene Felder herausfiltert und nur die angeforderten Daten zurückgibt.

Einige der wichtigsten verfügbaren Funktionen:

• Unterstützung für JSON-Objekte und JSON-Arrays.
  So kann Milogo Felder für JSON-Antworten filtern, die mit einer Reihe von Elementen oder nur mit einem einzelnen Element beginnen.

• Unterstützung für das Herausfiltern von Feldern in verschachtelten JSON-Objekten.
  Milogo unterstützt auch das Filtern verschachtelter JSON-Objekte mit dem folgenden Format, z. B. Code, Preis (Menge)

• Unterstützung für JSON, verpackt in einem anderen JSON.
  Manchmal werden die JSON-Antworten in ein anderes JSON-Objekt eingeschlossen. Milogo unterstützt das Filtern der tatsächlichen Nutzlast (siehe Beispiel verpackt):
  

// GET /products?fields=code,price(amount)
{
  "data": [
    {
      "code": 1,
      "price": {
        "amount": 100
      }
    },
    ...
  ],
  "_metadata": {
    ...
  }
}

Erste Schritte

Wie jede Gin-Middleware ist Milogo wirklich einfach zu verwenden und einzurichten. Sie können der README-Datei im Github-Repository folgen, aber grundsätzlich:

r := gin.Default()
r.Use(Milogo())

reicht aus, um Milogo-Middleware zu Ihrer API hinzuzufügen.

Im vorherigen Beispiel wird Milogo auf jeden einzelnen Endpunkt angewendet, es ist jedoch auch möglich, nur auf eine Gruppe von Endpunkten oder nur auf einen bestimmten Endpunkt anzuwenden, z. B.

group := r.Group("/products", milogo.Milogo())
group.GET("", productsHandler)

Im vorherigen Beispiel würde nur die Gruppe /products die Milogo-Middleware anwenden.

Abschluss

Milogo wurde entwickelt, um die REST-API-Entwicklung zu vereinfachen und die Client-Server-Interaktionen zu verbessern. Beispiele und Dokumentation finden Sie im GitHub-Repository.

Zögern Sie nicht, uns zu kontaktieren oder einen Beitrag zu leisten – lassen Sie uns gemeinsam REST-APIs effizient machen!

Das obige ist der detaillierte Inhalt vonVereinfachen Sie Ihre REST-API-Antworten mit Milogo für Gin-Gonic. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!