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!