From ee050e8d858d0b6a54b108be7e52d98e7a603472 Mon Sep 17 00:00:00 2001 From: OZGCloud <ozgcloud@mgm-tp.com> Date: Wed, 27 Nov 2024 11:36:14 +0100 Subject: [PATCH] updated README --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d0c8122..43e75cb 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ https://github.com/bufbuild/buf?tab=readme-ov-file ### Proto Dateien anpassen -Die *.proto Dateien, die die verwendetetn GRPC Apis des Proxys definieren müssen aus den entsprechenden Projekten +Die *.proto Dateien, die die verwendeten GRPC Apis des Proxys definieren müssen aus den entsprechenden Projekten in das Verzeichnis api/proto kopiert werden. Die Projekte sind: @@ -47,7 +47,16 @@ Damit die Code generierung funktioniert müssen die proto-Dateien aktuell noch a Dazu muss in jede Datei die Zeile ```option go_package = "de.ozgcloud.antragraumproxy";``` hinzugefügt werden, damit die erzeugten Quellcode-Dateien im selben go package liegen. -### Protobuf-Code und swagger datei generieren +### Generierung konfigurieren + +Die Generierung des Gateways kann mit den Dateien + +* api/gateway-config.yml - go Code für den Gateway +* api/openapi-config.yml - für die Erzeugung der swagger json Dateien + +konfiguriert werden. + +### Protobuf-Code und swagger Datei generieren ``` buf generate -- GitLab