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.
<code>components: schemas: User: type: object properties: id: type: string example: 123 readOnly: true email: type: string example: me@example.com writeOnly: true name: type: string example: Alice</code>
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

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

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

OpenSSL bietet als Open -Source -Bibliothek, die in der sicheren Kommunikation weit verbreitet sind, Verschlüsselungsalgorithmen, Tasten und Zertifikatverwaltungsfunktionen. In seiner historischen Version sind jedoch einige Sicherheitslücken bekannt, von denen einige äußerst schädlich sind. Dieser Artikel konzentriert sich auf gemeinsame Schwachstellen und Antwortmaßnahmen für OpenSSL in Debian -Systemen. DebianopensL Bekannte Schwachstellen: OpenSSL hat mehrere schwerwiegende Schwachstellen erlebt, wie z. Ein Angreifer kann diese Sicherheitsanfälligkeit für nicht autorisierte Lesen sensibler Informationen auf dem Server verwenden, einschließlich Verschlüsselungsschlüssel usw.

Backend Learning Path: Die Erkundungsreise von Front-End zu Back-End als Back-End-Anfänger, der sich von der Front-End-Entwicklung verwandelt, Sie haben bereits die Grundlage von Nodejs, ...

In der Bibliothek, die für den Betrieb der Schwimmpunktnummer in der GO-Sprache verwendet wird, wird die Genauigkeit sichergestellt, wie die Genauigkeit ...

Das Problem der Warteschlange Threading In Go Crawler Colly untersucht das Problem der Verwendung der Colly Crawler Library in Go -Sprache. Entwickler stoßen häufig auf Probleme mit Threads und Anfordern von Warteschlangen. � ...

Wie kann man im Beegoorm -Framework die mit dem Modell zugeordnete Datenbank angeben? In vielen BeEGO -Projekten müssen mehrere Datenbanken gleichzeitig betrieben werden. Bei Verwendung von BeEGO ...

Der Unterschied zwischen Stringdruck in GO -Sprache: Der Unterschied in der Wirkung der Verwendung von Println und String () ist in Go ...

Das Problem der Verwendung von RETISTREAM zur Implementierung von Nachrichtenwarteschlangen in der GO -Sprache besteht darin, die Go -Sprache und Redis zu verwenden ...

Was soll ich tun, wenn die benutzerdefinierten Strukturbezeichnungen in Goland nicht angezeigt werden? Bei der Verwendung von Goland für GO -Sprachentwicklung begegnen viele Entwickler benutzerdefinierte Struktur -Tags ...
