Heim Backend-Entwicklung Golang Hinzufügen von Filterabfrageparametern in Go Huma

Hinzufügen von Filterabfrageparametern in Go Huma

Dec 07, 2024 am 04:38 AM

Nach allem, was ich herausfinden konnte, unterstützt Huma leider keine Array-Abfragefilter wie diesen: filter[]=filter1&filters[]=filter2 (ohne die Klammern wegzulassen, z. B. filter=filter1&filter=filter2). Ich bin auf dieses Github-Problem gestoßen, das ein Beispiel für die Trennung der Filter durch Kommas gibt: https://github.com/danielgtaylor/huma/issues/325, also haben wir am Ende Folgendes gemacht: filter=postcode:eq:RM7(EX, erstellt:gt:2024-01-01

Filter dokumentieren

Im Gegensatz zu den Body-Parametern, die man einfach als Strukturen angeben kann und die dann sowohl validiert als auch in der Dokumentation generiert werden, muss die Dokumentation und Validierung für Filter separat erfolgen.

Die Dokumentation kann einfach unter dem Beschreibungsattribut des Huma.Param-Objekts (unter Operation) hinzugefügt werden:

Parameters: []*huma.Param{{
            Name: "filters",
            In:   "query",
            Description: "Filter properties by various fields. Separate filters by comma.\n\n" +
                "Format: field:operator:value\n\n" +
                "Supported fields:\n" +
                "- postcode (operator: eq)\n" +
                "- created (operators: gt, lt, gte, lte)\n",
            Schema: &huma.Schema{
                Type: "string",
                Items: &huma.Schema{
                    Type:    "string",
                    Pattern: "^[a-zA-Z_]+:(eq|neq|gt|lt|gte|lte):[a-zA-Z0-9-:.]+$",
                },
                Examples: []any{
                    "postcode:eq:RM7 8EX",
                    "created:gt:2024-01-01",
                },
            },
            Required: false,
        }},

Adding filter query parameters in Go Huma

Wir können jetzt unsere PropertyFilterParams-Struktur zur Validierung definieren:

type FilterParam struct {
    Field    string
    Operator string
    Value    interface{}
}

type PropertyFilterParams struct {
    Items []FilterParam
}

func (s *PropertyFilterParams) UnmarshalText(text []byte) error {
    equalityFields := []string{"postcode"}
    greaterSmallerFields := []string{}
    dateFields := []string{"created"}

    for _, item := range strings.Split(string(text), ",") {
        filterParam, err := parseAndValidateFilterItem(item, equalityFields, greaterSmallerFields, dateFields)
        if err != nil {
            return err
        }
        s.Items = append(s.Items, filterParam)
    }

    return nil
}

func (s *PropertyFilterParams) Schema(registry huma.Registry) *huma.Schema {
    return &huma.Schema{
        Type: huma.TypeString,
    }
}

func parseAndValidateFilterItem(item string, equalityFields []string, greaterSmallerFields []string, dateFields []string) (FilterParam, error) {
    parts := strings.SplitN(item, ":", 3)

    field := parts[0]
    operator := parts[1]
    value := parts[2]

    if contains(equalityFields, field) {
        if operator != "eq" && operator != "neq" {
            return FilterParam{}, fmt.Errorf("Unsupported operator %s for field %s. Only 'eq' and 'neq' are supported.", operator, field)
        }
    } else if contains(greaterSmallerFields, field) {
        if !validation.IsValidCompareGreaterSmallerOperator(operator) {
            return FilterParam{}, fmt.Errorf("Unsupported operator %s for field %s. Supported operators: eq, neq, gt, lt, gte, lte.", operator, field)
        }
    } else if contains(dateFields, field) {
        if !validation.IsValidCompareGreaterSmallerOperator(operator) {
            return FilterParam{}, fmt.Errorf("Unsupported operator %s for field %s. Supported operators: eq, neq, gt, lt, gte, lte.", operator, field)
        }
        if !validation.IsValidDate(value) {
            return FilterParam{}, fmt.Errorf("Invalid date format: %s. Expected: YYYY-MM-DD", value)
        }
    } else {
        return FilterParam{}, fmt.Errorf("Unsupported filter field: %s", field)
    }

    return FilterParam{Field: field, Operator: operator, Value: value}, nil
}

Ich habe PropertyFilterParams zur PropertyQueryParams-Struktur hinzugefügt:

type PropertyQueryParams struct {
    PaginationParams
    Filter PropertyFilterParams `query:"filters" doc:"Filter properties by various fields"`
    Sort   PropertySortParams   `query:"sorts" doc:"Sort properties by various fields"`
}

So sieht das Hinzufügen von PropertyQueryParams zur Route aus (beachten Sie, dass sich der Operationscode selbst, einschließlich der Filterbeschreibung, unter getAllPropertyOperation befindet – ich habe dafür nicht den vollständigen Code eingefügt, aber hoffentlich verstehen Sie das Wesentliche) . Wenn die Validierung fehlschlägt, wird eine 422-Antwort ausgegeben. Ich habe auch hinzugefügt, wie wir die übergebenen Filterwerte durchlaufen können:

huma.Register(api, getAllPropertyOperation(schema, "get-properties", "/properties", []string{"Properties"}),
        func(ctx context.Context, input *struct {
            models.Headers
            models.PropertyQueryParams
        }) (*models.MultiplePropertyOutput, error) {

            for _, filter := range input.Filter.Items {
                fmt.Println(filter)
            }

            return mockMultiplePropertyResponse(), err
        })
}

Ich hoffe, das hilft jemandem. Lassen Sie mich in den Kommentaren wissen, wenn Sie eine bessere Lösung gefunden haben.

Das obige ist der detaillierte Inhalt vonHinzufügen von Filterabfrageparametern in Go Huma. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Erklärung dieser Website
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn

Heiße KI -Werkzeuge

Undress AI Tool

Undress AI Tool

Ausziehbilder kostenlos

Undresser.AI Undress

Undresser.AI Undress

KI-gestützte App zum Erstellen realistischer Aktfotos

AI Clothes Remover

AI Clothes Remover

Online-KI-Tool zum Entfernen von Kleidung aus Fotos.

Clothoff.io

Clothoff.io

KI-Kleiderentferner

Video Face Swap

Video Face Swap

Tauschen Sie Gesichter in jedem Video mühelos mit unserem völlig kostenlosen KI-Gesichtstausch-Tool aus!

Heiße Werkzeuge

Notepad++7.3.1

Notepad++7.3.1

Einfach zu bedienender und kostenloser Code-Editor

SublimeText3 chinesische Version

SublimeText3 chinesische Version

Chinesische Version, sehr einfach zu bedienen

Senden Sie Studio 13.0.1

Senden Sie Studio 13.0.1

Leistungsstarke integrierte PHP-Entwicklungsumgebung

Dreamweaver CS6

Dreamweaver CS6

Visuelle Webentwicklungstools

SublimeText3 Mac-Version

SublimeText3 Mac-Version

Codebearbeitungssoftware auf Gottesniveau (SublimeText3)

Heiße Themen

PHP-Tutorial
1510
276
So erstellen Sie einen Webserver in Go So erstellen Sie einen Webserver in Go Jul 15, 2025 am 03:05 AM

Es ist nicht schwierig, einen in Go geschriebenen Webserver zu erstellen. Der Kern liegt in der Verwendung des NET/HTTP -Pakets zur Implementierung grundlegender Dienste. 1. Verwenden Sie Net/HTTP, um den einfachsten Server zu starten: Registrieren Sie die Verarbeitungsfunktionen und hören Sie Ports über einige Codezeilen an. 2. Routing -Management: Verwenden Sie ServeMux, um mehrere Schnittstellenpfade für eine einfache strukturierte Verwaltung zu organisieren. 3. Häufige Praktiken: Gruppenrouting nach funktionalen Modulen und verwenden Bibliotheken von Drittanbietern, um eine komplexe Übereinstimmung zu unterstützen. 4. Statischer Dateidienst: Geben Sie HTML-, CSS- und JS -Dateien über http.FileServer an; 5. Leistung und Sicherheit: Aktivieren Sie HTTPS, begrenzen Sie die Größe des Anforderungsorganisation und stellen Sie Zeitüberschreitungen ein, um die Sicherheit und Leistung zu verbessern. Nach dem Beherrschen dieser Schlüsselpunkte ist es einfacher, die Funktionalität zu erweitern.

Gehen Sie für Audio-/Videoverarbeitung Gehen Sie für Audio-/Videoverarbeitung Jul 20, 2025 am 04:14 AM

Der Kern der Audio- und Videoverarbeitung liegt darin, die grundlegenden Prozess- und Optimierungsmethoden zu verstehen. 1. Der grundlegende Prozess umfasst Akquisition, Codierung, Übertragung, Decodierung und Wiedergabe, und jeder Link hat technische Schwierigkeiten. 2. Häufige Probleme wie Audio- und Video -Aberration, Verzögerungsverzögerung, Schallgeräusch, verschwommenes Bild usw. können durch synchrone Einstellung, Codierungsoptimierung, Rauschverringerungsmodul, Parameteranpassung usw. gelöst werden; 3.. Es wird empfohlen, FFMPEG, OpenCV, Webrtc, Gstreamer und andere Tools zu verwenden, um Funktionen zu erzielen. 4. In Bezug auf das Leistungsmanagement sollten wir auf die Beschleunigung der Hardware, die angemessene Einstellung der Auflösungsrahmenquoten, die Kontrollverkehr und Speicher -Leckage -Probleme achten. Wenn Sie diese wichtigen Punkte beherrschen, werden die Entwicklungseffizienz und die Benutzererfahrung verbessert.

Entwicklung von Kubernetes -Betreibern in Go Entwicklung von Kubernetes -Betreibern in Go Jul 25, 2025 am 02:38 AM

Der effizienteste Weg, um einen Kubernetesoperator zu schreiben, besteht darin, GO zu verwenden, um Kubebuilder und Controller-Runtime zu kombinieren. 1. Verstehen Sie das Bedienermuster: Definieren Sie benutzerdefinierte Ressourcen über CRD, schreiben Sie einen Controller, um auf Ressourcenänderungen zu hören und Versöhnungsschleifen durchzuführen, um den erwarteten Zustand aufrechtzuerhalten. 2. Verwenden Sie Kubebuilder, um das Projekt zu initialisieren und APIs zu erstellen, um automatisch CRDs, Controller und Konfigurationsdateien zu generieren. 1. Definieren Sie die Spezifikation und die Statusstruktur von CRD in API/v1/myapp_types.go und führen Sie MakeManifests aus, um Crdyaml zu generieren. 4.. Versöhnung im Controller

GO -Abfrageoptimierungstechniken für PostgreSQL/MySQL GO -Abfrageoptimierungstechniken für PostgreSQL/MySQL Jul 19, 2025 am 03:56 AM

TooptimizeGoapplicationssinteractingwithpostgresqlormysql, FocusonIndexing, Selektivquerien, Verbindungshandling, Caching, Andormeffizienz.1) UseProperIndexing-IdentifizierfrequentqueriedColumns, addIndexesselektiv, andusecomposeFrequent-Formulti-kolumnquerquer

GO -Kanäle erklärt GO -Kanäle erklärt Jul 15, 2025 am 03:01 AM

Go-Kanäle sind in zwei Arten unterteilt: gepuffert und nicht gepuffert. Der nicht gepufferte Kanal erfordert das Senden und Empfangen, um gleichzeitig für koordinierte und synchrone Operationen geeignet zu sein. Während mit dem gepufferten Kanal die Daten vorübergehend gespeichert werden können, geeignet für die Entkopplung von Systemkomponenten. Achten Sie bei der Verwendung nicht, um das Blockieren zu vermeiden, indem Sie auf den vollständigen Pufferkanal schreiben oder aus dem leeren Kanal lesen und den Kanal rechtzeitig schließen, um den Empfänger über die Datenende zu informieren.

Lesen von Stdin in Go durch Beispiel Lesen von Stdin in Go durch Beispiel Jul 27, 2025 am 04:15 AM

Verwenden Sie FMT.Scanf, um formatierte Eingaben zu lesen, die für einfache strukturierte Daten geeignet sind. Die Zeichenfolge wird jedoch bei der Begegnung von Räumen abgeschnitten. 2. Es wird empfohlen, bufio.scanner zum Lesen von Zeile für die Zeile zu verwenden, unterstützt Multi-Line-Ein-, EOF-Erkennung und Pipeline-Eingang und kann Scanfehler verarbeiten. 3. Verwenden Sie IO.Readall (OS.Stdin), um alle Eingaben gleichzeitig zu lesen, die für die Verarbeitung großer Blockdaten oder Dateiströme geeignet sind. 4. Echtzeit-Schlüsselantwort erfordert Bibliotheken von Drittanbietern wie golang.org/x/term, und Bufio reicht für herkömmliche Szenarien aus. Praktische Vorschläge: Verwenden Sie FMT.Scan für die interaktive einfache Eingabe, verwenden Sie bufio.scanner für die Linieneingabe oder -pipeline, verwenden

Go OAuth2 Client- und Server -Implementierungen Go OAuth2 Client- und Server -Implementierungen Jul 16, 2025 am 02:57 AM

Die OAUTH2 -Implementierung ist in Client und Server unterteilt. Der Client verwendet das Paket golang.org/x/oauth2. Die Schritte sind: 1. Einführung des Pakets; 2. Konfigurieren Sie die Clientinformationen und erstellen Sie ein Konfigurationsobjekt. 3.. Erstellen Sie einen Autorisierungsverbindungslink; 4. Verarbeiten Sie den Rückruf, um das Token zu erhalten; 5. Konstruieren Sie einen HTTP -Client mit Autorisierung. Der Server nimmt als Beispiel Go-OAUTH2/OAuth2 an, und der Prozess umfasst: 1. Speicher initialisieren; 2. Setzen Sie Clientinformationen; 3.. Erstellen Sie die OAuth2 -Serviceinstanz; V. Zu den Anmerkungen gehören: Cross-Domänen-Probleme, Statusüberprüfung, Aktivitäten von HTTPs, Token-Validitätsmanagement und Granularität der Bereichskontrolle.

Gehen Sie für wissenschaftliches Computer und numerische Analyse Gehen Sie für wissenschaftliches Computer und numerische Analyse Jul 23, 2025 am 01:53 AM

GO -Sprache kann für wissenschaftliche Berechnungen und numerische Analysen verwendet werden, muss jedoch verstanden werden. Der Vorteil liegt in der Parallelitätsunterstützung und -leistung, die für parallele Algorithmen wie verteilte Lösung, Monte -Carlo -Simulation usw. geeignet ist; Community -Bibliotheken wie Gonum und MAT64 bieten grundlegende numerische Berechnungsfunktionen; Hybridprogrammierung kann verwendet werden, um C/C und Python über CGO oder Schnittstelle aufzurufen, um die Praktikabilität zu verbessern. Die Einschränkung besteht darin, dass das Ökosystem nicht so reif ist wie Python, die Visualisierung und die erweiterten Tools schwächer und einige Bibliotheksdokumente unvollständig sind. Es wird empfohlen, geeignete Szenarien basierend auf GO -Funktionen auszuwählen und sich auf die Beispiele für Quellcode zu verweisen, um sie ausführlich zu verwenden.

See all articles