Erstellen und Bereitstellen einer neuen API (Teil 1)
Dieser Blogbeitrag beschreibt die ersten Schritte beim Aufbau einer neuen API und konzentriert sich dabei auf die Einrichtung der Projektstruktur und die Generierung des ersten Codes. Ziel ist es, mit einer Vielzahl moderner Tools eine robuste und testbare API zu erstellen.
Der Technologie-Stack umfasst: OpenAPI für die Spezifikation, oapi-codegen für die Servergenerierung, Testify für Tests, Codecov für die Abdeckungsberichterstattung, Docker für die Containerisierung, PostgreSQL für die Datenbank, GORM als ORM, Flyway für Datenbankmigrationen, Kubernetes für die Orchestrierung , Terraform für Infrastruktur als Code und Caddy als potenzieller Webserver.
API-Spezifikation:
Das Projekt beginnt mit einer einfachen OpenAPI-Spezifikation für eine User
Ressource. Das User
-Schema umfasst ein id
, email
und name
. Das id
ist schreibgeschützt und das email
ist schreibgeschützt.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
|
Dieses Schema wird verwendet, um einen POST-Endpunkt bei /users
zu definieren, der bei Erfolg einen Statuscode 201 (Erstellt) und bei Fehlern 400 (Bad Request) ein JSON-Objekt mit Problemdetails zurückgibt.
Codegenerierung:
oapi-codegen
wird verwendet, um den Servercode aus der OpenAPI-Spezifikation zu generieren. Konfigurationsdateien (server.config.yaml
und types.config.yaml
) werden verwendet, um den generierten Code anzupassen. Eine tools.go
-Datei verwendet go generate
, um diesen Prozess zu automatisieren.
Handler-Implementierung und -Tests:
Eine grundlegende Serverstruktur wird erstellt, die die generierte Serverschnittstelle implementiert. Es ist ein PostUser
-Handler implementiert, der zunächst nil
-Werte zurückgibt. Gleichzeitig werden Unit-Tests mit Testify geschrieben, um das erwartete Verhalten zu definieren. Da die Datenbank noch nicht integriert ist, sind die Testantworten vorerst fest codiert.
Zukünftige Schritte umfassen das Erstellen der main.go
-Datei, eines Dockerfile
, die Integration von Codecov für kontinuierliche Tests und die Verbindung der API mit der PostgreSQL-Datenbank. Für weitere Details steht das Projekt-Repository zur Verfügung: https://www.php.cn/link/f72a23858b9865a40479a3ce3f16649e
Das obige ist der detaillierte Inhalt vonErstellen und Bereitstellen einer neuen API (Teil 1). Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Heiße KI -Werkzeuge

Undresser.AI Undress
KI-gestützte App zum Erstellen realistischer Aktfotos

AI Clothes Remover
Online-KI-Tool zum Entfernen von Kleidung aus Fotos.

Undress AI Tool
Ausziehbilder kostenlos

Clothoff.io
KI-Kleiderentferner

AI Hentai Generator
Erstellen Sie kostenlos Ai Hentai.

Heißer Artikel

Heiße Werkzeuge

Notepad++7.3.1
Einfach zu bedienender und kostenloser Code-Editor

SublimeText3 chinesische Version
Chinesische Version, sehr einfach zu bedienen

Senden Sie Studio 13.0.1
Leistungsstarke integrierte PHP-Entwicklungsumgebung

Dreamweaver CS6
Visuelle Webentwicklungstools

SublimeText3 Mac-Version
Codebearbeitungssoftware auf Gottesniveau (SublimeText3)

Heiße Themen

Dieser Artikel erläutert die Paketimportmechanismen von Go: benannte Importe (z. B. importieren & quot; fmt & quot;) und leere Importe (z. B. Import _ & quot; fmt & quot;). Benannte Importe machen Paketinhalte zugänglich, während leere Importe nur T ausführen

In diesem Artikel werden die Newflash () -Funktion von BeEGO für die Übertragung zwischen PAGE in Webanwendungen erläutert. Es konzentriert sich auf die Verwendung von Newflash (), um temporäre Nachrichten (Erfolg, Fehler, Warnung) zwischen den Controllern anzuzeigen und den Sitzungsmechanismus zu nutzen. Limita

Dieser Artikel beschreibt die effiziente Konvertierung von MySQL -Abfrageergebnissen in GO -Strukturscheiben. Es wird unter Verwendung der SCAN -Methode von Datenbank/SQL zur optimalen Leistung hervorgehoben, wobei die manuelle Parsen vermieden wird. Best Practices für die Struktur -Feldzuordnung mithilfe von DB -Tags und Robus

In diesem Artikel werden die benutzerdefinierten Typ -Einschränkungen von GO für Generika untersucht. Es wird beschrieben, wie Schnittstellen die minimalen Typanforderungen für generische Funktionen definieren und die Sicherheitstypsicherheit und die Wiederverwendbarkeit von Code verbessern. Der Artikel erörtert auch Einschränkungen und Best Practices

Dieser Artikel zeigt, dass Mocks und Stubs in GO für Unit -Tests erstellen. Es betont die Verwendung von Schnittstellen, liefert Beispiele für Mock -Implementierungen und diskutiert Best Practices wie die Fokussierung von Mocks und die Verwendung von Assertion -Bibliotheken. Die Articl

Dieser Artikel beschreibt effizientes Dateischreiben in Go und vergleicht OS.WriteFile (geeignet für kleine Dateien) mit OS.openfile und gepufferter Schreibvorgänge (optimal für große Dateien). Es betont eine robuste Fehlerbehandlung, die Verwendung von Aufschub und Überprüfung auf bestimmte Fehler.

In dem Artikel werden Schreiben von Unit -Tests in GO erörtert, die Best Practices, Spottechniken und Tools für ein effizientes Testmanagement abdecken.

In diesem Artikel wird die Verwendung von Tracing -Tools zur Analyse von GO -Anwendungsausführungsfluss untersucht. Es werden manuelle und automatische Instrumentierungstechniken, den Vergleich von Tools wie Jaeger, Zipkin und Opentelemetrie erörtert und die effektive Datenvisualisierung hervorheben
